docs: Updating the app_cookie_stickiness_policy docs to reflect needing a L…

[stack72]

…oadBalancer name NOT Id

Fixes #2926

[radeksimko]

Name and ID are actually equal, so it does not matter, but it's nice to be explicit in docs. 👍

[radeksimko]

When I tried applying this example, I got an error:

1 error(s) occurred:

* aws_app_cookie_stickiness_policy.foo: Error creating AppCookieStickinessPolicy: ValidationError: Policy name cannot contain characters that are not letters, or digits or the dash.
    status code: 400, request id: c96ca9bd-5eed-11e5-b3c8-1b09bd7b9609

It would be nice to add validation for aws_app_cookie_stickiness_policy.name, but more importantly the example should be fixed - e.g. by replacing underscore with dash.

[stack72]

Ah so this is actually an error with app_cookie_stickiness_policy?
On 19 Sep 2015 5:50 pm, "Radek Simko" notifications@github.com wrote:

In
website/source/docs/providers/aws/r/app_cookie_stickiness_policy.html.markdown
#3277 (comment):

}

resource "aws_app_cookie_stickiness_policy" "foo" {

• name = "foo_policy"
  

• load_balancer = "${aws_elb.lb.id}"
  

• lb_port = 80
  

• cookie_name = "MyAppCookie"
  

• name = "foo_policy"

This is however wrong, when I tried applying this example, I got an error:

1 error(s) occurred:

• aws_app_cookie_stickiness_policy.foo: Error creating AppCookieStickinessPolicy: ValidationError: Policy name cannot contain characters that are not letters, or digits or the dash.
  status code: 400, request id: c96ca9bd-5eed-11e5-b3c8-1b09bd7b9609

It would be nice to add validation for
aws_app_cookie_stickiness_policy.name, but more importantly the example
should be fixed - e.g. by replacing underscore with dash.

—
Reply to this email directly or view it on GitHub
https://github.com/hashicorp/terraform/pull/3277/files#r39921319.

[radeksimko]

Well, you didn't cause this by your changes 😃 but the example has invalid name for some reason, so I think we can fix it.

[stack72]

Cool - I'll update my PR to include the ValidateFunc and an updated example. May also check we have acceptance tests that cover it :)

[stack72]

@radeksimko the validation rules for this are not actually noted anywhere

http://docs.aws.amazon.com/cli/latest/reference/elb/create-app-cookie-stickiness-policy.html

just says:

--policy-name (string)

The name of the policy being created. This name must be unique within the set of policies for this load balancer.

I am not sure where this error comes from. Even the go-sdk doesn't seem to list the specific error you are getting:

https://github.com/aws/aws-sdk-go/blob/master/apis/elasticloadbalancing/2012-06-01/api-2.json#L178

[radeksimko]

Hm, you're right, AWS docs are not always matching with the reality. I will open a support case, encourage them to update it. I've been already reporting some RDS validation, which was out of date the other day.

Until they document it, I think we should just validate against what the error says (i.e. alphanumeric + dash). Feel free to test certain edge cases, like two dashes, dashes at either end of the name, but I'd guess these will be allowed, based on the error message.

[stack72]

kk, will update the PR with the Validation :)

-- 
Paul
Sent with Airmail

On 19 September 2015 at 19:55:51, Radek Simko (notifications@github.com) wrote:

In website/source/docs/providers/aws/r/app_cookie_stickiness_policy.html.markdown:

}

resource "aws_app_cookie_stickiness_policy" "foo" {

• name = "foo_policy"
• load_balancer = "${aws_elb.lb.id}"
• lb_port = 80
• cookie_name = "MyAppCookie"
• name = "foo_policy"
  Hm, you're right, AWS docs are not always matching with the reality. I will open a support case, encourage them to update it. I've been already reporting some RDS validation, which was out of date the other day.

Until they document it, I think we should just validate against what the error says (i.e. alphanumeric + dash). Feel free to test certain edge cases, like two dashes, dashes at either end of the name, but I'd guess these will be allowed, based on the error message.

—
Reply to this email directly or view it on GitHub.

[radeksimko]

FYI: I just opened the support ticket, here's a copy: https://gist.github.com/radeksimko/f01168a61cbaa222b16c

[stack72]

@radeksimko this is now working as expected - i was able to reproduce this with the acceptance tests. I will open a subsequent PR to add a func that allows an acceptance test for throwing the correct validation errors :)

[radeksimko]

Thank you for your patience here, @stack72

This LGTM now 👍

[ghost]

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.

If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.