Skip to content

Commit 95abe4b

Browse files
author
awstools
committed
docs(client-lightsail): Documentation updates for Lightsail
1 parent 22870a0 commit 95abe4b

File tree

5 files changed

+24
-71
lines changed

5 files changed

+24
-71
lines changed

‎clients/client-lightsail/src/Lightsail.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4340,8 +4340,8 @@ export class Lightsail extends LightsailClient {
43404340
* <p>Returns a list of TLS security policies that you can apply to Lightsail load
43414341
* balancers.</p>
43424342
*
4343-
* <p>For more information about load balancer TLS security policies, see <a href="https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configure-load-balancer-tls-security-policy">Load balancer TLS security policies</a> in the <i>Amazon Lightsail Developer
4344-
* Guide</i>.</p>
4343+
* <p>For more information about load balancer TLS security policies, see <a href="https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configure-load-balancer-tls-security-policy">Configuring TLS security policies on your Amazon Lightsail load
4344+
* balancers</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>
43454345
*/
43464346
public getLoadBalancerTlsPolicies(
43474347
args: GetLoadBalancerTlsPoliciesCommandInput,

‎clients/client-lightsail/src/commands/GetLoadBalancerTlsPoliciesCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ export interface GetLoadBalancerTlsPoliciesCommandOutput extends GetLoadBalancer
2525
* <p>Returns a list of TLS security policies that you can apply to Lightsail load
2626
* balancers.</p>
2727
*
28-
* <p>For more information about load balancer TLS security policies, see <a href="https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configure-load-balancer-tls-security-policy">Load balancer TLS security policies</a> in the <i>Amazon Lightsail Developer
29-
* Guide</i>.</p>
28+
* <p>For more information about load balancer TLS security policies, see <a href="https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configure-load-balancer-tls-security-policy">Configuring TLS security policies on your Amazon Lightsail load
29+
* balancers</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>
3030
* @example
3131
* Use a bare-bones client and the command you need to make an API call.
3232
* ```javascript

‎clients/client-lightsail/src/models/models_0.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5851,8 +5851,8 @@ export interface CreateLoadBalancerRequest {
58515851
* <p>Use the <a href="https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetLoadBalancerTlsPolicies.html">GetLoadBalancerTlsPolicies</a> action to get a list of TLS policy names that you can
58525852
* specify.</p>
58535853
*
5854-
* <p>For more information about load balancer TLS policies, see <a href="https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configure-load-balancer-tls-security-policy">Load balancer TLS security policies</a> in the <i>Amazon Lightsail Developer
5855-
* Guide</i>.</p>
5854+
* <p>For more information about load balancer TLS policies, see <a href="https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configure-load-balancer-tls-security-policy">Configuring TLS security policies on your Amazon Lightsail load
5855+
* balancers</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>
58565856
*/
58575857
tlsPolicyName?: string;
58585858
}

‎clients/client-lightsail/src/models/models_1.ts

Lines changed: 11 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1763,20 +1763,6 @@ export interface LoadBalancer {
17631763

17641764
/**
17651765
* <p>The name of the TLS security policy for the load balancer.</p>
1766-
*
1767-
* <p>The following TLS security policy names are possible:</p>
1768-
* <ul>
1769-
* <li>
1770-
* <p>
1771-
* <code>TLS-2016-08</code>
1772-
* </p>
1773-
* </li>
1774-
* <li>
1775-
* <p>
1776-
* <code>TLS-FS-Res-1-2-2019-08</code>
1777-
* </p>
1778-
* </li>
1779-
* </ul>
17801766
*/
17811767
tlsPolicyName?: string;
17821768
}
@@ -2685,31 +2671,13 @@ export namespace GetLoadBalancerTlsPoliciesRequest {
26852671
* <p>Describes the TLS security policies that are available for Lightsail load
26862672
* balancers.</p>
26872673
*
2688-
* <p>For more information about load balancer TLS security policies, see <a href="https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configure-load-balancer-tls-security-policy">Load balancer TLS security policies</a> in the <i>Amazon Lightsail
2689-
* Developer Guide</i>.</p>
2674+
* <p>For more information about load balancer TLS security policies, see <a href="https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configure-load-balancer-tls-security-policy">Configuring TLS security policies on your Amazon Lightsail load
2675+
* balancers</a> in the <i>Amazon Lightsail Developer
2676+
* Guide</i>.</p>
26902677
*/
26912678
export interface LoadBalancerTlsPolicy {
26922679
/**
26932680
* <p>The name of the TLS security policy.</p>
2694-
*
2695-
* <p>The following TLS security policy names are possible:</p>
2696-
*
2697-
* <ul>
2698-
* <li>
2699-
* <p>
2700-
* <code>TLS-2016-08</code>
2701-
* </p>
2702-
* </li>
2703-
* <li>
2704-
* <p>
2705-
* <code>TLS-FS-Res-1-2-2019-08</code>
2706-
* </p>
2707-
* </li>
2708-
* </ul>
2709-
*
2710-
* <p>You can specify either of these values for the <code>tlsSecurityPolicyName</code> request
2711-
* parameter in the <a href="https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateLoadBalancer.html">CreateLoadBalancer</a> action, and the <code>attributeValue</code> request parameter in
2712-
* the <a href="https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_UpdateLoadBalancerAttribute.html">UpdateLoadBalancerAttribute</a> action.</p>
27132681
*/
27142682
name?: string;
27152683

@@ -2725,25 +2693,6 @@ export interface LoadBalancerTlsPolicy {
27252693

27262694
/**
27272695
* <p>The protocols used in a given TLS security policy.</p>
2728-
*
2729-
* <p>The following protocols are possible:</p>
2730-
* <ul>
2731-
* <li>
2732-
* <p>
2733-
* <code>Protocol-TLSv1</code>
2734-
* </p>
2735-
* </li>
2736-
* <li>
2737-
* <p>
2738-
* <code>Protocol-TLSv1.1</code>
2739-
* </p>
2740-
* </li>
2741-
* <li>
2742-
* <p>
2743-
* <code>Protocol-TLSv1.2</code>
2744-
* </p>
2745-
* </li>
2746-
* </ul>
27472696
*/
27482697
protocols?: string[];
27492698

@@ -5905,7 +5854,8 @@ export interface UpdateLoadBalancerAttributeRequest {
59055854
* <li>
59065855
* <p>If you specify <code>SessionStickinessEnabled</code> for the
59075856
* <code>attributeName</code> request parameter, then the <code>attributeValue</code>
5908-
* request parameter must be <code>true</code> or <code>false</code>.</p>
5857+
* request parameter must be <code>true</code> to activate session stickiness or
5858+
* <code>false</code> to deactivate session stickiness.</p>
59095859
* </li>
59105860
* <li>
59115861
* <p>If you specify <code>SessionStickiness_LB_CookieDurationSeconds</code> for the
@@ -5916,12 +5866,15 @@ export interface UpdateLoadBalancerAttributeRequest {
59165866
* <li>
59175867
* <p>If you specify <code>HttpsRedirectionEnabled</code> for the <code>attributeName</code>
59185868
* request parameter, then the <code>attributeValue</code> request parameter must be
5919-
* <code>true</code> or <code>false</code>.</p>
5869+
* <code>true</code> to activate HTTP to HTTPS redirection or <code>false</code> to
5870+
* deactivate HTTP to HTTPS redirection.</p>
59205871
* </li>
59215872
* <li>
59225873
* <p>If you specify <code>TlsPolicyName</code> for the <code>attributeName</code> request
5923-
* parameter, then the <code>attributeValue</code> request parameter must be <code>TLS
5924-
* version 1.0, 1.1, and 1.2</code> or <code>TLS version 1.2</code>.</p>
5874+
* parameter, then the <code>attributeValue</code> request parameter must be the name of the
5875+
* TLS policy.</p>
5876+
* <p>Use the <a href="https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetLoadBalancerTlsPolicies.html">GetLoadBalancerTlsPolicies</a> action to get a list of TLS policy names that you
5877+
* can specify.</p>
59255878
* </li>
59265879
* </ul>
59275880
*/

‎codegen/sdk-codegen/aws-models/lightsail.json

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4575,7 +4575,7 @@
45754575
"tlsPolicyName": {
45764576
"target": "com.amazonaws.lightsail#string",
45774577
"traits": {
4578-
"smithy.api#documentation": "<p>The name of the TLS policy to apply to the load balancer.</p>\n\n <p>Use the <a href=\"https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetLoadBalancerTlsPolicies.html\">GetLoadBalancerTlsPolicies</a> action to get a list of TLS policy names that you can\n specify.</p>\n\n <p>For more information about load balancer TLS policies, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configure-load-balancer-tls-security-policy\">Load balancer TLS security policies</a> in the <i>Amazon Lightsail Developer\n Guide</i>.</p>"
4578+
"smithy.api#documentation": "<p>The name of the TLS policy to apply to the load balancer.</p>\n\n <p>Use the <a href=\"https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetLoadBalancerTlsPolicies.html\">GetLoadBalancerTlsPolicies</a> action to get a list of TLS policy names that you can\n specify.</p>\n\n <p>For more information about load balancer TLS policies, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configure-load-balancer-tls-security-policy\">Configuring TLS security policies on your Amazon Lightsail load\n balancers</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>"
45794579
}
45804580
}
45814581
}
@@ -10704,7 +10704,7 @@
1070410704
}
1070510705
],
1070610706
"traits": {
10707-
"smithy.api#documentation": "<p>Returns a list of TLS security policies that you can apply to Lightsail load\n balancers.</p>\n\n <p>For more information about load balancer TLS security policies, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configure-load-balancer-tls-security-policy\">Load balancer TLS security policies</a> in the <i>Amazon Lightsail Developer\n Guide</i>.</p>",
10707+
"smithy.api#documentation": "<p>Returns a list of TLS security policies that you can apply to Lightsail load\n balancers.</p>\n\n <p>For more information about load balancer TLS security policies, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configure-load-balancer-tls-security-policy\">Configuring TLS security policies on your Amazon Lightsail load\n balancers</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>",
1070810708
"smithy.api#http": {
1070910709
"method": "POST",
1071010710
"uri": "/ls/api/2016-11-28/GetLoadBalancerTlsPolicies",
@@ -14093,7 +14093,7 @@
1409314093
"tlsPolicyName": {
1409414094
"target": "com.amazonaws.lightsail#ResourceName",
1409514095
"traits": {
14096-
"smithy.api#documentation": "<p>The name of the TLS security policy for the load balancer.</p>\n\n <p>The following TLS security policy names are possible:</p>\n <ul>\n <li>\n <p>\n <code>TLS-2016-08</code>\n </p>\n </li>\n <li>\n <p>\n <code>TLS-FS-Res-1-2-2019-08</code>\n </p>\n </li>\n </ul>"
14096+
"smithy.api#documentation": "<p>The name of the TLS security policy for the load balancer.</p>"
1409714097
}
1409814098
}
1409914099
},
@@ -14681,7 +14681,7 @@
1468114681
"name": {
1468214682
"target": "com.amazonaws.lightsail#ResourceName",
1468314683
"traits": {
14684-
"smithy.api#documentation": "<p>The name of the TLS security policy.</p>\n\n <p>The following TLS security policy names are possible:</p>\n\n <ul>\n <li>\n <p>\n <code>TLS-2016-08</code>\n </p>\n </li>\n <li>\n <p>\n <code>TLS-FS-Res-1-2-2019-08</code>\n </p>\n </li>\n </ul>\n\n <p>You can specify either of these values for the <code>tlsSecurityPolicyName</code> request\n parameter in the <a href=\"https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateLoadBalancer.html\">CreateLoadBalancer</a> action, and the <code>attributeValue</code> request parameter in\n the <a href=\"https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_UpdateLoadBalancerAttribute.html\">UpdateLoadBalancerAttribute</a> action.</p>"
14684+
"smithy.api#documentation": "<p>The name of the TLS security policy.</p>"
1468514685
}
1468614686
},
1468714687
"isDefault": {
@@ -14699,7 +14699,7 @@
1469914699
"protocols": {
1470014700
"target": "com.amazonaws.lightsail#StringList",
1470114701
"traits": {
14702-
"smithy.api#documentation": "<p>The protocols used in a given TLS security policy.</p>\n\n <p>The following protocols are possible:</p>\n <ul>\n <li>\n <p>\n <code>Protocol-TLSv1</code>\n </p>\n </li>\n <li>\n <p>\n <code>Protocol-TLSv1.1</code>\n </p>\n </li>\n <li>\n <p>\n <code>Protocol-TLSv1.2</code>\n </p>\n </li>\n </ul>"
14702+
"smithy.api#documentation": "<p>The protocols used in a given TLS security policy.</p>"
1470314703
}
1470414704
},
1470514705
"ciphers": {
@@ -14710,7 +14710,7 @@
1471014710
}
1471114711
},
1471214712
"traits": {
14713-
"smithy.api#documentation": "<p>Describes the TLS security policies that are available for Lightsail load\n balancers.</p>\n\n <p>For more information about load balancer TLS security policies, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configure-load-balancer-tls-security-policy\">Load balancer TLS security policies</a> in the <i>Amazon Lightsail\n Developer Guide</i>.</p>"
14713+
"smithy.api#documentation": "<p>Describes the TLS security policies that are available for Lightsail load\n balancers.</p>\n\n <p>For more information about load balancer TLS security policies, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configure-load-balancer-tls-security-policy\">Configuring TLS security policies on your Amazon Lightsail load\n balancers</a> in the <i>Amazon Lightsail Developer\n Guide</i>.</p>"
1471414714
}
1471514715
},
1471614716
"com.amazonaws.lightsail#LoadBalancerTlsPolicyList": {
@@ -19029,7 +19029,7 @@
1902919029
"attributeValue": {
1903019030
"target": "com.amazonaws.lightsail#StringMax256",
1903119031
"traits": {
19032-
"smithy.api#documentation": "<p>The value that you want to specify for the attribute name.</p>\n <p>The following values are supported depending on what you specify for the\n <code>attributeName</code> request parameter:</p>\n <ul>\n <li>\n <p>If you specify <code>HealthCheckPath</code> for the <code>attributeName</code> request\n parameter, then the <code>attributeValue</code> request parameter must be the path to ping\n on the target (for example, <code>/weather/us/wa/seattle</code>).</p>\n </li>\n <li>\n <p>If you specify <code>SessionStickinessEnabled</code> for the\n <code>attributeName</code> request parameter, then the <code>attributeValue</code>\n request parameter must be <code>true</code> or <code>false</code>.</p>\n </li>\n <li>\n <p>If you specify <code>SessionStickiness_LB_CookieDurationSeconds</code> for the\n <code>attributeName</code> request parameter, then the <code>attributeValue</code>\n request parameter must be an interger that represents the cookie duration in\n seconds.</p>\n </li>\n <li>\n <p>If you specify <code>HttpsRedirectionEnabled</code> for the <code>attributeName</code>\n request parameter, then the <code>attributeValue</code> request parameter must be\n <code>true</code> or <code>false</code>.</p>\n </li>\n <li>\n <p>If you specify <code>TlsPolicyName</code> for the <code>attributeName</code> request\n parameter, then the <code>attributeValue</code> request parameter must be <code>TLS\n version 1.0, 1.1, and 1.2</code> or <code>TLS version 1.2</code>.</p>\n </li>\n </ul>",
19032+
"smithy.api#documentation": "<p>The value that you want to specify for the attribute name.</p>\n <p>The following values are supported depending on what you specify for the\n <code>attributeName</code> request parameter:</p>\n <ul>\n <li>\n <p>If you specify <code>HealthCheckPath</code> for the <code>attributeName</code> request\n parameter, then the <code>attributeValue</code> request parameter must be the path to ping\n on the target (for example, <code>/weather/us/wa/seattle</code>).</p>\n </li>\n <li>\n <p>If you specify <code>SessionStickinessEnabled</code> for the\n <code>attributeName</code> request parameter, then the <code>attributeValue</code>\n request parameter must be <code>true</code> to activate session stickiness or\n <code>false</code> to deactivate session stickiness.</p>\n </li>\n <li>\n <p>If you specify <code>SessionStickiness_LB_CookieDurationSeconds</code> for the\n <code>attributeName</code> request parameter, then the <code>attributeValue</code>\n request parameter must be an interger that represents the cookie duration in\n seconds.</p>\n </li>\n <li>\n <p>If you specify <code>HttpsRedirectionEnabled</code> for the <code>attributeName</code>\n request parameter, then the <code>attributeValue</code> request parameter must be\n <code>true</code> to activate HTTP to HTTPS redirection or <code>false</code> to\n deactivate HTTP to HTTPS redirection.</p>\n </li>\n <li>\n <p>If you specify <code>TlsPolicyName</code> for the <code>attributeName</code> request\n parameter, then the <code>attributeValue</code> request parameter must be the name of the\n TLS policy.</p>\n <p>Use the <a href=\"https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetLoadBalancerTlsPolicies.html\">GetLoadBalancerTlsPolicies</a> action to get a list of TLS policy names that you\n can specify.</p>\n </li>\n </ul>",
1903319033
"smithy.api#required": {}
1903419034
}
1903519035
}

0 commit comments

Comments
 (0)