Creates a block storage disk from a manual or automatic snapshot of a disk. The resulting
- * disk can be attached to an Amazon Lightsail instance in the same Availability Zone (us-east-2a).
us-east-2a).
* The create disk from snapshot operation supports tag-based access control via
* request tags and resource tags applied to the resource identified by disk snapshot
* name. For more information, see the Amazon Lightsail Developer Guide.
Returns detailed information for five of the most recent SetupInstanceHttps requests that were ran on the target instance.
Returns detailed information for five of the most recent SetupInstanceHttps
+ * requests that were ran on the target instance.
Creates an SSL/TLS certificate that secures traffic for your website. After the * certificate is created, it is installed on the specified Lightsail instance.
- *If you provide more than one domain name in the request, at least one name must be less than or equal to 63 characters in length.
+ *If you provide more than one domain name in the request, at least one name must be less + * than or equal to 63 characters in length.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-lightsail/src/models/models_0.ts b/clients/client-lightsail/src/models/models_0.ts index 266dc83f2ae2..03a10943e8ce 100644 --- a/clients/client-lightsail/src/models/models_0.ts +++ b/clients/client-lightsail/src/models/models_0.ts @@ -1751,8 +1751,8 @@ export type BlueprintType = (typeof BlueprintType)[keyof typeof BlueprintType]; */ export interface Blueprint { /** - *The ID for the virtual private server image (app_wordpress_4_4 or
- * app_lamp_7_0).
The ID for the virtual private server image (app_wordpress_x_x or
+ * app_lamp_x_x).
The version number of the operating system, application, or stack (
- * 2016.03.0).
2016.03.0).
* @public
*/
version?: string;
@@ -2155,13 +2155,13 @@ export interface Bundle {
diskSizeInGb?: number;
/**
- * The bundle ID (micro_1_0).
The bundle ID (micro_x_x).
The Amazon EC2 instance type (t2.micro).
The instance type (micro).
A numeric value that represents the power of the bundle (500). You can
- * use the bundle's power value in conjunction with a blueprint's minimum power value to
- * determine whether the blueprint will run on the bundle. For example, you need a bundle with a
- * power value of 500 or more to create an instance that uses a blueprint with a minimum power
- * value of 500.
A numeric value that represents the power of the bundle (500). You can use
+ * the bundle's power value in conjunction with a blueprint's minimum power value to determine
+ * whether the blueprint will run on the bundle. For example, you need a bundle with a power
+ * value of 500 or more to create an instance that uses a blueprint with a minimum power value of
+ * 500.
An integer that indicates the public ipv4 address count included in the bundle, the value is either 0 or 1.
+ *An integer that indicates the public ipv4 address count included in the bundle, the value + * is either 0 or 1.
* @public */ publicIpv4AddressCount?: number; @@ -2882,8 +2883,8 @@ export interface Certificate { serialNumber?: string; /** - *An array of strings that specify the alternate domains (example2.com)
- * and subdomains (blog.example.com) of the certificate.
An array of strings that specify the alternate domains (example2.com) and
+ * subdomains (blog.example.com) of the certificate.
fromPort parameter, and ICMP code using the
* toPort parameter.
*
+ *
+ * icmp6 - Internet Control Message Protocol (ICMP) for IPv6. When you
+ * specify icmp6 as the protocol, you must specify the ICMP type
+ * using the fromPort parameter, and ICMP code using the toPort
+ * parameter.
An array of strings that specify the alternate domains (example2.com)
- * and subdomains (blog.example.com) for the certificate.
An array of strings that specify the alternate domains (example2.com) and
+ * subdomains (blog.example.com) for the certificate.
You can specify a maximum of nine alternate domains (in addition to the primary domain * name).
*Wildcard domain entries (*.example.com) are not supported.
The Availability Zone where you want to create the disk (us-east-2a).
- * Use the same Availability Zone as the Lightsail instance to which you want to attach the
+ *
The Availability Zone where you want to create the disk (us-east-2a). Use the
+ * same Availability Zone as the Lightsail instance to which you want to attach the
* disk.
Use the get regions operation to list the Availability Zones where
* Lightsail is currently available.
The name of the disk snapshot (my-snapshot) from which to create the
- * new storage disk.
The name of the disk snapshot (my-snapshot) from which to create the new
+ * storage disk.
Constraint:
*The Availability Zone where you want to create the disk (us-east-2a).
- * Choose the same Availability Zone as the Lightsail instance where you want to create the
+ *
The Availability Zone where you want to create the disk (us-east-2a). Choose
+ * the same Availability Zone as the Lightsail instance where you want to create the
* disk.
Use the GetRegions operation to list the Availability Zones where Lightsail is currently * available.
@@ -5244,15 +5253,15 @@ export interface CreateDiskSnapshotRequest { diskName?: string; /** - *The name of the destination disk snapshot (my-disk-snapshot) based on
- * the source disk.
The name of the destination disk snapshot (my-disk-snapshot) based on the
+ * source disk.
The unique name of the source instance (Amazon_Linux-512MB-Virginia-1).
- * When this is defined, a snapshot of the instance's system volume is created.
The unique name of the source instance (Amazon_Linux-512MB-Virginia-1). When
+ * this is defined, a snapshot of the instance's system volume is created.
This parameter cannot be defined together with the disk name parameter. The
* instance name and disk name parameters are mutually
@@ -5289,6 +5298,7 @@ export interface CreateDiskSnapshotResult {
export const IpAddressType = {
DUALSTACK: "dualstack",
IPV4: "ipv4",
+ IPV6: "ipv6",
} as const;
/**
@@ -5313,9 +5323,9 @@ export type OriginProtocolPolicyEnum = (typeof OriginProtocolPolicyEnum)[keyof t
/**
*
Describes the origin resource of an Amazon Lightsail content delivery network (CDN) * distribution.
- *An origin can be a Lightsail instance, bucket, container service, or load balancer. A distribution pulls - * content from an origin, caches it, and serves it to viewers via a worldwide network of edge - * servers.
+ *An origin can be a Lightsail instance, bucket, container service, or load balancer. A + * distribution pulls content from an origin, caches it, and serves it to viewers via a worldwide + * network of edge servers.
* @public */ export interface InputOrigin { @@ -5339,8 +5349,9 @@ export interface InputOrigin { protocolPolicy?: OriginProtocolPolicyEnum; /** - *The amount of time, in seconds, that the distribution waits for a response after forwarding a request to the origin. - * The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 30 seconds.
+ *The amount of time, in seconds, that the distribution waits for a response after + * forwarding a request to the origin. The minimum timeout is 1 second, the maximum is 60 + * seconds, and the default (if you don't specify otherwise) is 30 seconds.
* @public */ responseTimeout?: number; @@ -5427,7 +5438,8 @@ export interface CreateDistributionRequest { /** *The name of the SSL/TLS certificate that you want to attach to the distribution.
- *Use the GetCertificates action to get a list of certificate names that you can specify.
+ *Use the GetCertificates + * action to get a list of certificate names that you can specify.
* @public */ certificateName?: string; @@ -5474,8 +5486,9 @@ export interface Origin { protocolPolicy?: OriginProtocolPolicyEnum; /** - *The amount of time, in seconds, that the distribution waits for a response after forwarding a request to the origin. - * The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 30 seconds.
+ *The amount of time, in seconds, that the distribution waits for a response after + * forwarding a request to the origin. The minimum timeout is 1 second, the maximum is 60 + * seconds, and the default (if you don't specify otherwise) is 30 seconds.
* @public */ responseTimeout?: number; @@ -5623,7 +5636,8 @@ export interface LightsailDistribution { tags?: Tag[]; /** - *The minimum TLS protocol version that the distribution can use to communicate with viewers.
+ *The minimum TLS protocol version that the distribution can use to communicate with + * viewers.
* @public */ viewerMinimumTlsProtocolVersion?: string; @@ -5695,7 +5709,8 @@ export interface DomainEntry { name?: string; /** - *The target IP address (192.0.2.0), or AWS name server (ns-111.awsdns-22.com.).
The target IP address (192.0.2.0), or AWS name server
+ * (ns-111.awsdns-22.com.).
For Lightsail load balancers, the value looks like
* ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com. For
* Lightsail distributions, the value looks like exampled1182ne.cloudfront.net.
@@ -5940,8 +5955,8 @@ export interface CreateInstancesRequest {
customImageName?: string;
/**
- *
The ID for a virtual private server image (app_wordpress_4_4 or
- * app_lamp_7_0). Use the get blueprints operation to return a list
+ *
The ID for a virtual private server image (app_wordpress_x_x or
+ * app_lamp_x_x). Use the get blueprints operation to return a list
* of available images (or blueprints).
Use active blueprints when creating new instances. Inactive blueprints are listed to @@ -5955,7 +5970,7 @@ export interface CreateInstancesRequest { /** *
The bundle of specification information for your virtual private server (or
- * instance), including the pricing plan (micro_1_0).
medium_x_x).
* @public
*/
bundleId: string | undefined;
@@ -5994,8 +6009,8 @@ export interface CreateInstancesRequest {
/**
* The IP address type for the instance.
- *The possible values are ipv4 for IPv4 only, and dualstack for
- * IPv4 and IPv6.
The possible values are ipv4 for IPv4 only, ipv6 for IPv6 only,
+ * and dualstack for IPv4 and IPv6.
The default value is dualstack.
The bundle of specification information for your virtual private server (or
- * instance), including the pricing plan (micro_1_0).
micro_x_x).
* @public
*/
bundleId: string | undefined;
@@ -6096,8 +6111,8 @@ export interface CreateInstancesFromSnapshotRequest {
/**
* The IP address type for the instance.
- *The possible values are ipv4 for IPv4 only, and dualstack for
- * IPv4 and IPv6.
The possible values are ipv4 for IPv4 only, ipv6 for IPv6 only,
+ * and dualstack for IPv4 and IPv6.
The default value is dualstack.
The Amazon Resource Name (ARN) of the key pair (arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE).
The Amazon Resource Name (ARN) of the key pair
+ * (arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE).
The domain name with which your certificate is associated (example.com).
The domain name with which your certificate is associated
+ * (example.com).
If you specify certificateDomainName, then certificateName is
* required (and vice-versa).
The optional alternative domains and subdomains to use with your SSL/TLS certificate
- * (www.example.com, example.com, m.example.com,
+ * (www.example.com, example.com, m.example.com,
* blog.example.com).
The IP address type for the load balancer.
- *The possible values are ipv4 for IPv4 only, and dualstack for
- * IPv4 and IPv6.
The possible values are ipv4 for IPv4 only, ipv6 for IPv6 only,
+ * and dualstack for IPv4 and IPv6.
The default value is dualstack.
An array of strings listing alternative domains and subdomains for your SSL/TLS
* certificate. Lightsail will de-dupe the names for you. You can have a maximum of 9
- * alternative names (in addition to the 1 primary domain). We do not support wildcards (*.example.com).
*.example.com).
* @public
*/
certificateAlternativeNames?: string[];
@@ -7508,7 +7526,8 @@ export interface DetachCertificateFromDistributionResult {
*/
export interface DetachDiskRequest {
/**
- * The unique name of the disk you want to detach from your instance (my-disk).
The unique name of the disk you want to detach from your instance
+ * (my-disk).
The Amazon Resource Name (ARN) of the domain recordset (arn:aws:lightsail:global:123456789101:Domain/824cede0-abc7-4f84-8dbc-12345EXAMPLE).
The Amazon Resource Name (ARN) of the domain recordset
+ * (arn:aws:lightsail:global:123456789101:Domain/824cede0-abc7-4f84-8dbc-12345EXAMPLE).
The bundle ID from which the source instance was created (micro_1_0).
The bundle ID from which the source instance was created (micro_x_x).
The blueprint ID from which the source instance (os_debian_8_3).
The blueprint ID from which the source instance (amazon_linux_2023).
The Lightsail resource type (InstanceSnapshot or
- * DiskSnapshot).
DiskSnapshot).
* @public
*/
resourceType?: ExportSnapshotRecordSourceType;
@@ -8529,7 +8549,8 @@ export interface GetAutoSnapshotsResult {
resourceName?: string;
/**
- * The resource type of the automatic snapshot. The possible values are Instance, and Disk.
The resource type of the automatic snapshot. The possible values are
+ * Instance, and Disk.
fromPort parameter, and ICMP code using the
* toPort parameter.
*
+ * icmp6 - Internet Control Message Protocol (ICMP) for IPv6. When you
+ * specify icmp6 as the protocol, you must specify the ICMP type
+ * using the fromPort parameter, and ICMP code using the toPort
+ * parameter.
The name the user gave the instance (Amazon_Linux-1GB-Ohio-1).
The name the user gave the instance (Amazon_Linux_2023-1).
The Amazon Resource Name (ARN) of the instance (arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE).
The Amazon Resource Name (ARN) of the instance
+ * (arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE).
The timestamp when the instance was created (1479734909.17) in Unix
- * time format.
The timestamp when the instance was created (1479734909.17) in Unix time
+ * format.
The blueprint ID (os_amlinux_2016_03).
The blueprint ID (amazon_linux_2023).
The friendly name of the blueprint (Amazon Linux).
The friendly name of the blueprint (Amazon Linux 2023).
The bundle for the instance (micro_1_0).
The bundle for the instance (micro_x_x).
The IP address type of the instance.
- *The possible values are ipv4 for IPv4 only, and dualstack for
- * IPv4 and IPv6.
The possible values are ipv4 for IPv4 only, ipv6 for IPv6 only,
+ * and dualstack for IPv4 and IPv6.
The name of the SSH key being used to connect to the instance (LightsailDefaultKeyPair).
The name of the SSH key being used to connect to the instance
+ * (LightsailDefaultKeyPair).
For SSH access, the temporary private key. For OpenSSH clients (command line SSH),
- * you should save this value to tempkey).
For SSH access, the temporary private key. For OpenSSH clients (command line SSH), you
+ * should save this value to tempkey).
fromPort parameter, and ICMP code using the
* toPort parameter.
*
+ *
+ * icmp6 - Internet Control Message Protocol (ICMP) for IPv6. When you
+ * specify icmp6 as the protocol, you must specify the ICMP type
+ * using the fromPort parameter, and ICMP code using the toPort
+ * parameter.
The Amazon Resource Name (ARN) of the snapshot (arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE).
The Amazon Resource Name (ARN) of the snapshot
+ * (arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE).
The Amazon Resource Name (ARN) of the instance from which the snapshot was created (arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE).
The Amazon Resource Name (ARN) of the instance from which the snapshot was created
+ * (arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE).
The blueprint ID from which you created the snapshot (os_debian_8_3). A
+ *
The blueprint ID from which you created the snapshot (amazon_linux_2023). A
* blueprint is a virtual private server (or instance) image used to create
* instances quickly.
The bundle ID from which you created the snapshot (micro_1_0).
The bundle ID from which you created the snapshot (micro_x_x).
The AWS Region where your load balancer was created (us-east-2a).
- * Lightsail automatically creates your load balancer across Availability Zones.
The AWS Region where your load balancer was created (us-east-2a). Lightsail
+ * automatically creates your load balancer across Availability Zones.
The IP address type of the load balancer.
- *The possible values are ipv4 for IPv4 only, and dualstack for
- * IPv4 and IPv6.
The possible values are ipv4 for IPv4 only, ipv6 for IPv6 only,
+ * and dualstack for IPv4 and IPv6.
An array of strings that specify the alternate domains (example2.com)
- * and subdomains (blog.example.com) for the certificate.
An array of strings that specify the alternate domains (example2.com) and
+ * subdomains (blog.example.com) for the certificate.
A Boolean value indicating whether to also include Availability Zones for databases in
- * your get regions request. Availability Zones are indicated with a letter (us-east-2a).
us-east-2a).
* @public
*/
includeRelationalDatabaseAvailabilityZones?: boolean;
@@ -3760,8 +3779,8 @@ export interface Region {
continentCode?: string;
/**
- * The description of the Amazon Web Services Region (This region is recommended
- * to serve users in the eastern United States and eastern Canada).
The description of the Amazon Web Services Region (This region is recommended to
+ * serve users in the eastern United States and eastern Canada).
The token to advance to the next page of results from your request.
- *To get a page token, perform an initial GetSetupHistory request. If your results
- * are paginated, the response will return a next page token that you can specify as the page
- * token in a subsequent request.
To get a page token, perform an initial GetSetupHistory request. If your
+ * results are paginated, the response will return a next page token that you can specify as the
+ * page token in a subsequent request.
Returns information that was submitted during the SetupInstanceHttps request. Email
- * information is redacted for privacy.
Returns information that was submitted during the SetupInstanceHttps request.
+ * Email information is redacted for privacy.
The token to advance to the next page of results from your request.
*A next page token is not returned if there are no more results to display.
- *To get the next page of results, perform another GetSetupHistory request and specify
- * the next page token using the pageToken parameter.
To get the next page of results, perform another GetSetupHistory request and
+ * specify the next page token using the pageToken parameter.
The Amazon Resource Name (ARN) of the static IP (arn:aws:lightsail:us-east-2:123456789101:StaticIp/9cbb4a9e-f8e3-4dfe-b57e-12345EXAMPLE).
The Amazon Resource Name (ARN) of the static IP
+ * (arn:aws:lightsail:us-east-2:123456789101:StaticIp/9cbb4a9e-f8e3-4dfe-b57e-12345EXAMPLE).
The instance where the static IP is attached (Amazon_Linux-1GB-Ohio-1).
The instance where the static IP is attached
+ * (Amazon_Linux-1GB-Ohio-1).
The IP address type to set for the specified resource.
- *The possible values are ipv4 for IPv4 only, and dualstack for
- * IPv4 and IPv6.
The possible values are ipv4 for IPv4 only, ipv6 for IPv6 only,
+ * and dualstack for IPv4 and IPv6.
Required parameter to accept the instance bundle update when changing to, and from, + * IPv6-only.
+ *An instance bundle will change when switching from dual-stack or
+ * ipv4, to ipv6. It also changes when switching from
+ * ipv6, to dual-stack or ipv4.
You must include this parameter in the command to update the bundle. For example, if you
+ * switch from dual-stack to ipv6, the bundle will be updated, and
+ * billing for the IPv6-only instance bundle begins immediately.
Use this parameter to update the minimum TLS protocol version for the SSL/TLS certificate that's attached to the distribution.
+ *Use this parameter to update the minimum TLS protocol version for the SSL/TLS certificate + * that's attached to the distribution.
* @public */ viewerMinimumTlsProtocolVersion?: ViewerMinimumTlsProtocolVersionEnum; /** *The name of the SSL/TLS certificate that you want to attach to the distribution.
- *Only certificates with a status of ISSUED can be attached to a distribution.
Use the GetCertificates action to get a list of certificate names that you can specify.
+ *Only certificates with a status of ISSUED can be attached to a
+ * distribution.
Use the GetCertificates + * action to get a list of certificate names that you can specify.
* @public */ certificateName?: string; /** - *Indicates whether the default SSL/TLS certificate is attached to the distribution. The default value is true. When true, the distribution uses the default domain name such as d111111abcdef8.cloudfront.net.
Set this value to false to attach a new certificate to the distribution.
Indicates whether the default SSL/TLS certificate is attached to the distribution. The
+ * default value is true. When true, the distribution uses the default
+ * domain name such as d111111abcdef8.cloudfront.net.
Set this value to false to attach a new certificate to the
+ * distribution.
The name of the load balancer that you want to modify (my-load-balancer.
The name of the load balancer that you want to modify
+ * (my-load-balancer.
The ID for the virtual private server image (app_wordpress_4_4 or\n app_lamp_7_0).
The ID for the virtual private server image (app_wordpress_x_x or\n app_lamp_x_x).
The version number of the operating system, application, or stack (\n 2016.03.0).
The version number of the operating system, application, or stack (\n 2016.03.0).
The bundle ID (micro_1_0).
The bundle ID (micro_x_x).
The Amazon EC2 instance type (t2.micro).
The instance type (micro).
A numeric value that represents the power of the bundle (500). You can\n use the bundle's power value in conjunction with a blueprint's minimum power value to\n determine whether the blueprint will run on the bundle. For example, you need a bundle with a\n power value of 500 or more to create an instance that uses a blueprint with a minimum power\n value of 500.
A numeric value that represents the power of the bundle (500). You can use\n the bundle's power value in conjunction with a blueprint's minimum power value to determine\n whether the blueprint will run on the bundle. For example, you need a bundle with a power\n value of 500 or more to create an instance that uses a blueprint with a minimum power value of\n 500.
An integer that indicates the public ipv4 address count included in the bundle, the value is either 0 or 1.
" + "smithy.api#documentation": "An integer that indicates the public ipv4 address count included in the bundle, the value\n is either 0 or 1.
" } } }, @@ -1800,7 +1800,7 @@ "subjectAlternativeNames": { "target": "com.amazonaws.lightsail#SubjectAlternativeNameList", "traits": { - "smithy.api#documentation": "An array of strings that specify the alternate domains (example2.com)\n and subdomains (blog.example.com) of the certificate.
An array of strings that specify the alternate domains (example2.com) and\n subdomains (blog.example.com) of the certificate.
An array of strings that specify the alternate domains (example2.com)\n and subdomains (blog.example.com) for the certificate.
You can specify a maximum of nine alternate domains (in addition to the primary domain\n name).
\nWildcard domain entries (*.example.com) are not supported.
An array of strings that specify the alternate domains (example2.com) and\n subdomains (blog.example.com) for the certificate.
You can specify a maximum of nine alternate domains (in addition to the primary domain\n name).
\nWildcard domain entries (*.example.com) are not supported.
Creates a block storage disk from a manual or automatic snapshot of a disk. The resulting\n disk can be attached to an Amazon Lightsail instance in the same Availability Zone (us-east-2a).
The create disk from snapshot operation supports tag-based access control via\n request tags and resource tags applied to the resource identified by disk snapshot\n name. For more information, see the Amazon Lightsail Developer Guide.
Creates a block storage disk from a manual or automatic snapshot of a disk. The resulting\n disk can be attached to an Amazon Lightsail instance in the same Availability Zone\n (us-east-2a).
The create disk from snapshot operation supports tag-based access control via\n request tags and resource tags applied to the resource identified by disk snapshot\n name. For more information, see the Amazon Lightsail Developer Guide.
The name of the disk snapshot (my-snapshot) from which to create the\n new storage disk.
Constraint:
\nThis parameter cannot be defined together with the source disk name\n parameter. The disk snapshot name and source disk name\n parameters are mutually exclusive.
The name of the disk snapshot (my-snapshot) from which to create the new\n storage disk.
Constraint:
\nThis parameter cannot be defined together with the source disk name\n parameter. The disk snapshot name and source disk name\n parameters are mutually exclusive.
The Availability Zone where you want to create the disk (us-east-2a).\n Choose the same Availability Zone as the Lightsail instance where you want to create the\n disk.
Use the GetRegions operation to list the Availability Zones where Lightsail is currently\n available.
", + "smithy.api#documentation": "The Availability Zone where you want to create the disk (us-east-2a). Choose\n the same Availability Zone as the Lightsail instance where you want to create the\n disk.
Use the GetRegions operation to list the Availability Zones where Lightsail is currently\n available.
", "smithy.api#required": {} } }, @@ -4104,7 +4104,7 @@ "availabilityZone": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "The Availability Zone where you want to create the disk (us-east-2a).\n Use the same Availability Zone as the Lightsail instance to which you want to attach the\n disk.
Use the get regions operation to list the Availability Zones where\n Lightsail is currently available.
The Availability Zone where you want to create the disk (us-east-2a). Use the\n same Availability Zone as the Lightsail instance to which you want to attach the\n disk.
Use the get regions operation to list the Availability Zones where\n Lightsail is currently available.
The name of the destination disk snapshot (my-disk-snapshot) based on\n the source disk.
The name of the destination disk snapshot (my-disk-snapshot) based on the\n source disk.
The unique name of the source instance (Amazon_Linux-512MB-Virginia-1).\n When this is defined, a snapshot of the instance's system volume is created.
This parameter cannot be defined together with the disk name parameter. The\n instance name and disk name parameters are mutually\n exclusive.
The unique name of the source instance (Amazon_Linux-512MB-Virginia-1). When\n this is defined, a snapshot of the instance's system volume is created.
This parameter cannot be defined together with the disk name parameter. The\n instance name and disk name parameters are mutually\n exclusive.
The name of the SSL/TLS certificate that you want to attach to the distribution.
\nUse the GetCertificates action to get a list of certificate names that you can specify.
" + "smithy.api#documentation": "The name of the SSL/TLS certificate that you want to attach to the distribution.
\nUse the GetCertificates\n action to get a list of certificate names that you can specify.
" } }, "viewerMinimumTlsProtocolVersion": { @@ -4794,7 +4794,7 @@ "bundleId": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { - "smithy.api#documentation": "The bundle of specification information for your virtual private server (or\n instance), including the pricing plan (micro_1_0).
The bundle of specification information for your virtual private server (or\n instance), including the pricing plan (micro_x_x).
The IP address type for the instance.
\nThe possible values are ipv4 for IPv4 only, and dualstack for\n IPv4 and IPv6.
The default value is dualstack.
The IP address type for the instance.
\nThe possible values are ipv4 for IPv4 only, ipv6 for IPv6 only,\n and dualstack for IPv4 and IPv6.
The default value is dualstack.
The ID for a virtual private server image (app_wordpress_4_4 or\n app_lamp_7_0). Use the get blueprints operation to return a list\n of available images (or blueprints).
Use active blueprints when creating new instances. Inactive blueprints are listed to\n support customers with existing instances and are not necessarily available to create new\n instances. Blueprints are marked inactive when they become outdated due to operating system\n updates or new application releases.
\nThe ID for a virtual private server image (app_wordpress_x_x or\n app_lamp_x_x). Use the get blueprints operation to return a list\n of available images (or blueprints).
Use active blueprints when creating new instances. Inactive blueprints are listed to\n support customers with existing instances and are not necessarily available to create new\n instances. Blueprints are marked inactive when they become outdated due to operating system\n updates or new application releases.
\nThe bundle of specification information for your virtual private server (or\n instance), including the pricing plan (micro_1_0).
The bundle of specification information for your virtual private server (or\n instance), including the pricing plan (medium_x_x).
The IP address type for the instance.
\nThe possible values are ipv4 for IPv4 only, and dualstack for\n IPv4 and IPv6.
The default value is dualstack.
The IP address type for the instance.
\nThe possible values are ipv4 for IPv4 only, ipv6 for IPv6 only,\n and dualstack for IPv4 and IPv6.
The default value is dualstack.
The domain name with which your certificate is associated (example.com).
If you specify certificateDomainName, then certificateName is\n required (and vice-versa).
The domain name with which your certificate is associated\n (example.com).
If you specify certificateDomainName, then certificateName is\n required (and vice-versa).
The optional alternative domains and subdomains to use with your SSL/TLS certificate\n (www.example.com, example.com, m.example.com,\n blog.example.com).
The optional alternative domains and subdomains to use with your SSL/TLS certificate\n (www.example.com, example.com, m.example.com,\n blog.example.com).
The IP address type for the load balancer.
\nThe possible values are ipv4 for IPv4 only, and dualstack for\n IPv4 and IPv6.
The default value is dualstack.
The IP address type for the load balancer.
\nThe possible values are ipv4 for IPv4 only, ipv6 for IPv6 only,\n and dualstack for IPv4 and IPv6.
The default value is dualstack.
An array of strings listing alternative domains and subdomains for your SSL/TLS\n certificate. Lightsail will de-dupe the names for you. You can have a maximum of 9\n alternative names (in addition to the 1 primary domain). We do not support wildcards (*.example.com).
An array of strings listing alternative domains and subdomains for your SSL/TLS\n certificate. Lightsail will de-dupe the names for you. You can have a maximum of 9\n alternative names (in addition to the 1 primary domain). We do not support wildcards\n (*.example.com).
The unique name of the disk you want to detach from your instance (my-disk).
The unique name of the disk you want to detach from your instance\n (my-disk).
The Amazon Resource Name (ARN) of the domain recordset (arn:aws:lightsail:global:123456789101:Domain/824cede0-abc7-4f84-8dbc-12345EXAMPLE).
The Amazon Resource Name (ARN) of the domain recordset\n (arn:aws:lightsail:global:123456789101:Domain/824cede0-abc7-4f84-8dbc-12345EXAMPLE).
The target IP address (192.0.2.0), or AWS name server (ns-111.awsdns-22.com.).
For Lightsail load balancers, the value looks like\n ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com. For\n Lightsail distributions, the value looks like exampled1182ne.cloudfront.net.\n For Lightsail container services, the value looks like\n container-service-1.example23scljs.us-west-2.cs.amazonlightsail.com. Be sure to\n also set isAlias to true when setting up an A record for a\n Lightsail load balancer, distribution, or container service.
The target IP address (192.0.2.0), or AWS name server\n (ns-111.awsdns-22.com.).
For Lightsail load balancers, the value looks like\n ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com. For\n Lightsail distributions, the value looks like exampled1182ne.cloudfront.net.\n For Lightsail container services, the value looks like\n container-service-1.example23scljs.us-west-2.cs.amazonlightsail.com. Be sure to\n also set isAlias to true when setting up an A record for a\n Lightsail load balancer, distribution, or container service.
The Lightsail resource type (InstanceSnapshot or\n DiskSnapshot).
The Lightsail resource type (InstanceSnapshot or\n DiskSnapshot).
The resource type of the automatic snapshot. The possible values are Instance, and Disk.
The resource type of the automatic snapshot. The possible values are\n Instance, and Disk.
A Boolean value indicating whether to also include Availability Zones for databases in\n your get regions request. Availability Zones are indicated with a letter (us-east-2a).
A Boolean value indicating whether to also include Availability Zones for databases in\n your get regions request. Availability Zones are indicated with a letter\n (us-east-2a).
Returns detailed information for five of the most recent SetupInstanceHttps requests that were ran on the target instance.
Returns detailed information for five of the most recent SetupInstanceHttps\n requests that were ran on the target instance.
The token to advance to the next page of results from your request.
\nTo get a page token, perform an initial GetSetupHistory request. If your results\n are paginated, the response will return a next page token that you can specify as the page\n token in a subsequent request.
The token to advance to the next page of results from your request.
\nTo get a page token, perform an initial GetSetupHistory request. If your\n results are paginated, the response will return a next page token that you can specify as the\n page token in a subsequent request.
The token to advance to the next page of results from your request.
\nA next page token is not returned if there are no more results to display.
\nTo get the next page of results, perform another GetSetupHistory request and specify\n the next page token using the pageToken parameter.
The token to advance to the next page of results from your request.
\nA next page token is not returned if there are no more results to display.
\nTo get the next page of results, perform another GetSetupHistory request and\n specify the next page token using the pageToken parameter.
The amount of time, in seconds, that the distribution waits for a response after forwarding a request to the origin.\n The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 30 seconds.
" + "smithy.api#documentation": "The amount of time, in seconds, that the distribution waits for a response after\n forwarding a request to the origin. The minimum timeout is 1 second, the maximum is 60\n seconds, and the default (if you don't specify otherwise) is 30 seconds.
" } } }, "traits": { - "smithy.api#documentation": "Describes the origin resource of an Amazon Lightsail content delivery network (CDN)\n distribution.
\nAn origin can be a Lightsail instance, bucket, container service, or load balancer. A distribution pulls\n content from an origin, caches it, and serves it to viewers via a worldwide network of edge\n servers.
" + "smithy.api#documentation": "Describes the origin resource of an Amazon Lightsail content delivery network (CDN)\n distribution.
\nAn origin can be a Lightsail instance, bucket, container service, or load balancer. A\n distribution pulls content from an origin, caches it, and serves it to viewers via a worldwide\n network of edge servers.
" } }, "com.amazonaws.lightsail#Instance": { @@ -13986,13 +13986,13 @@ "name": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "The name the user gave the instance (Amazon_Linux-1GB-Ohio-1).
The name the user gave the instance (Amazon_Linux_2023-1).
The Amazon Resource Name (ARN) of the instance (arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE).
The Amazon Resource Name (ARN) of the instance\n (arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE).
The timestamp when the instance was created (1479734909.17) in Unix\n time format.
The timestamp when the instance was created (1479734909.17) in Unix time\n format.
The blueprint ID (os_amlinux_2016_03).
The blueprint ID (amazon_linux_2023).
The friendly name of the blueprint (Amazon Linux).
The friendly name of the blueprint (Amazon Linux 2023).
The bundle for the instance (micro_1_0).
The bundle for the instance (micro_x_x).
The IP address type of the instance.
\nThe possible values are ipv4 for IPv4 only, and dualstack for\n IPv4 and IPv6.
The IP address type of the instance.
\nThe possible values are ipv4 for IPv4 only, ipv6 for IPv6 only,\n and dualstack for IPv4 and IPv6.
The name of the SSH key being used to connect to the instance (LightsailDefaultKeyPair).
The name of the SSH key being used to connect to the instance\n (LightsailDefaultKeyPair).
For SSH access, the temporary private key. For OpenSSH clients (command line SSH),\n you should save this value to tempkey).
For SSH access, the temporary private key. For OpenSSH clients (command line SSH), you\n should save this value to tempkey).
The IP protocol name.
\nThe name can be one of the following:
\n\n tcp - Transmission Control Protocol (TCP) provides reliable, ordered, and\n error-checked delivery of streamed data between applications running on hosts\n communicating by an IP network. If you have an application that doesn't require reliable\n data stream service, use UDP instead.
\n all - All transport layer protocol types. For more general information,\n see Transport layer on\n Wikipedia.
\n udp - With User Datagram Protocol (UDP), computer applications can send\n messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior\n communications are not required to set up transmission channels or data paths.\n Applications that don't require reliable data stream service can use UDP, which provides a\n connectionless datagram service that emphasizes reduced latency over reliability. If you\n do require reliable data stream service, use TCP instead.
\n icmp - Internet Control Message Protocol (ICMP) is used to send error\n messages and operational information indicating success or failure when communicating with\n an instance. For example, an error is indicated when an instance could not be reached.\n When you specify icmp as the protocol, you must specify the ICMP\n type using the fromPort parameter, and ICMP code using the\n toPort parameter.
The IP protocol name.
\nThe name can be one of the following:
\n\n tcp - Transmission Control Protocol (TCP) provides reliable, ordered, and\n error-checked delivery of streamed data between applications running on hosts\n communicating by an IP network. If you have an application that doesn't require reliable\n data stream service, use UDP instead.
\n all - All transport layer protocol types. For more general information,\n see Transport layer on\n Wikipedia.
\n udp - With User Datagram Protocol (UDP), computer applications can send\n messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior\n communications are not required to set up transmission channels or data paths.\n Applications that don't require reliable data stream service can use UDP, which provides a\n connectionless datagram service that emphasizes reduced latency over reliability. If you\n do require reliable data stream service, use TCP instead.
\n icmp - Internet Control Message Protocol (ICMP) is used to send error\n messages and operational information indicating success or failure when communicating with\n an instance. For example, an error is indicated when an instance could not be reached.\n When you specify icmp as the protocol, you must specify the ICMP\n type using the fromPort parameter, and ICMP code using the\n toPort parameter.
\n icmp6 - Internet Control Message Protocol (ICMP) for IPv6. When you\n specify icmp6 as the protocol, you must specify the ICMP type\n using the fromPort parameter, and ICMP code using the toPort\n parameter.
The IP protocol name.
\nThe name can be one of the following:
\n\n tcp - Transmission Control Protocol (TCP) provides reliable, ordered, and\n error-checked delivery of streamed data between applications running on hosts\n communicating by an IP network. If you have an application that doesn't require reliable\n data stream service, use UDP instead.
\n all - All transport layer protocol types. For more general information,\n see Transport layer on\n Wikipedia.
\n udp - With User Datagram Protocol (UDP), computer applications can send\n messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior\n communications are not required to set up transmission channels or data paths.\n Applications that don't require reliable data stream service can use UDP, which provides a\n connectionless datagram service that emphasizes reduced latency over reliability. If you\n do require reliable data stream service, use TCP instead.
\n icmp - Internet Control Message Protocol (ICMP) is used to send error\n messages and operational information indicating success or failure when communicating with\n an instance. For example, an error is indicated when an instance could not be reached.\n When you specify icmp as the protocol, you must specify the ICMP\n type using the fromPort parameter, and ICMP code using the\n toPort parameter.
The IP protocol name.
\nThe name can be one of the following:
\n\n tcp - Transmission Control Protocol (TCP) provides reliable, ordered, and\n error-checked delivery of streamed data between applications running on hosts\n communicating by an IP network. If you have an application that doesn't require reliable\n data stream service, use UDP instead.
\n all - All transport layer protocol types. For more general information,\n see Transport layer on\n Wikipedia.
\n udp - With User Datagram Protocol (UDP), computer applications can send\n messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior\n communications are not required to set up transmission channels or data paths.\n Applications that don't require reliable data stream service can use UDP, which provides a\n connectionless datagram service that emphasizes reduced latency over reliability. If you\n do require reliable data stream service, use TCP instead.
\n icmp - Internet Control Message Protocol (ICMP) is used to send error\n messages and operational information indicating success or failure when communicating with\n an instance. For example, an error is indicated when an instance could not be reached.\n When you specify icmp as the protocol, you must specify the ICMP\n type using the fromPort parameter, and ICMP code using the\n toPort parameter.
\n icmp6 - Internet Control Message Protocol (ICMP) for IPv6. When you\n specify icmp6 as the protocol, you must specify the ICMP type\n using the fromPort parameter, and ICMP code using the toPort\n parameter.
The Amazon Resource Name (ARN) of the snapshot (arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE).
The Amazon Resource Name (ARN) of the snapshot\n (arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE).
The Amazon Resource Name (ARN) of the instance from which the snapshot was created (arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE).
The Amazon Resource Name (ARN) of the instance from which the snapshot was created\n (arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE).
The blueprint ID from which you created the snapshot (os_debian_8_3). A\n blueprint is a virtual private server (or instance) image used to create\n instances quickly.
The blueprint ID from which you created the snapshot (amazon_linux_2023). A\n blueprint is a virtual private server (or instance) image used to create\n instances quickly.
The bundle ID from which you created the snapshot (micro_1_0).
The bundle ID from which you created the snapshot (micro_x_x).
The bundle ID from which the source instance was created (micro_1_0).
The bundle ID from which the source instance was created (micro_x_x).
The blueprint ID from which the source instance (os_debian_8_3).
The blueprint ID from which the source instance (amazon_linux_2023).
The Amazon Resource Name (ARN) of the key pair (arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE).
The Amazon Resource Name (ARN) of the key pair\n (arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE).
The minimum TLS protocol version that the distribution can use to communicate with viewers.
" + "smithy.api#documentation": "The minimum TLS protocol version that the distribution can use to communicate with\n viewers.
" } } }, @@ -16559,7 +16565,7 @@ "location": { "target": "com.amazonaws.lightsail#ResourceLocation", "traits": { - "smithy.api#documentation": "The AWS Region where your load balancer was created (us-east-2a).\n Lightsail automatically creates your load balancer across Availability Zones.
The AWS Region where your load balancer was created (us-east-2a). Lightsail\n automatically creates your load balancer across Availability Zones.
The IP address type of the load balancer.
\nThe possible values are ipv4 for IPv4 only, and dualstack for\n IPv4 and IPv6.
The IP address type of the load balancer.
\nThe possible values are ipv4 for IPv4 only, ipv6 for IPv6 only,\n and dualstack for IPv4 and IPv6.
An array of strings that specify the alternate domains (example2.com)\n and subdomains (blog.example.com) for the certificate.
An array of strings that specify the alternate domains (example2.com) and\n subdomains (blog.example.com) for the certificate.
The amount of time, in seconds, that the distribution waits for a response after forwarding a request to the origin.\n The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 30 seconds.
" + "smithy.api#documentation": "The amount of time, in seconds, that the distribution waits for a response after\n forwarding a request to the origin. The minimum timeout is 1 second, the maximum is 60\n seconds, and the default (if you don't specify otherwise) is 30 seconds.
" } } }, @@ -18989,7 +19001,7 @@ "protocol": { "target": "com.amazonaws.lightsail#NetworkProtocol", "traits": { - "smithy.api#documentation": "The IP protocol name.
\nThe name can be one of the following:
\n\n tcp - Transmission Control Protocol (TCP) provides reliable, ordered, and\n error-checked delivery of streamed data between applications running on hosts\n communicating by an IP network. If you have an application that doesn't require reliable\n data stream service, use UDP instead.
\n all - All transport layer protocol types. For more general information,\n see Transport layer on\n Wikipedia.
\n udp - With User Datagram Protocol (UDP), computer applications can send\n messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior\n communications are not required to set up transmission channels or data paths.\n Applications that don't require reliable data stream service can use UDP, which provides a\n connectionless datagram service that emphasizes reduced latency over reliability. If you\n do require reliable data stream service, use TCP instead.
\n icmp - Internet Control Message Protocol (ICMP) is used to send error\n messages and operational information indicating success or failure when communicating with\n an instance. For example, an error is indicated when an instance could not be reached.\n When you specify icmp as the protocol, you must specify the ICMP\n type using the fromPort parameter, and ICMP code using the\n toPort parameter.
The IP protocol name.
\nThe name can be one of the following:
\n\n tcp - Transmission Control Protocol (TCP) provides reliable, ordered, and\n error-checked delivery of streamed data between applications running on hosts\n communicating by an IP network. If you have an application that doesn't require reliable\n data stream service, use UDP instead.
\n all - All transport layer protocol types. For more general information,\n see Transport layer on\n Wikipedia.
\n udp - With User Datagram Protocol (UDP), computer applications can send\n messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior\n communications are not required to set up transmission channels or data paths.\n Applications that don't require reliable data stream service can use UDP, which provides a\n connectionless datagram service that emphasizes reduced latency over reliability. If you\n do require reliable data stream service, use TCP instead.
\n icmp - Internet Control Message Protocol (ICMP) is used to send error\n messages and operational information indicating success or failure when communicating with\n an instance. For example, an error is indicated when an instance could not be reached.\n When you specify icmp as the protocol, you must specify the ICMP\n type using the fromPort parameter, and ICMP code using the\n toPort parameter.
\n icmp6 - Internet Control Message Protocol (ICMP) for IPv6. When you\n specify icmp6 as the protocol, you must specify the ICMP type\n using the fromPort parameter, and ICMP code using the toPort\n parameter.
The description of the Amazon Web Services Region (This region is recommended\n to serve users in the eastern United States and eastern Canada).
The description of the Amazon Web Services Region (This region is recommended to\n serve users in the eastern United States and eastern Canada).
The IP address type to set for the specified resource.
\nThe possible values are ipv4 for IPv4 only, and dualstack for\n IPv4 and IPv6.
The IP address type to set for the specified resource.
\nThe possible values are ipv4 for IPv4 only, ipv6 for IPv6 only,\n and dualstack for IPv4 and IPv6.
Required parameter to accept the instance bundle update when changing to, and from,\n IPv6-only.
\nAn instance bundle will change when switching from dual-stack or\n ipv4, to ipv6. It also changes when switching from\n ipv6, to dual-stack or ipv4.
You must include this parameter in the command to update the bundle. For example, if you\n switch from dual-stack to ipv6, the bundle will be updated, and\n billing for the IPv6-only instance bundle begins immediately.
Creates an SSL/TLS certificate that secures traffic for your website. After the\n certificate is created, it is installed on the specified Lightsail instance.
\nIf you provide more than one domain name in the request, at least one name must be less than or equal to 63 characters in length.
", + "smithy.api#documentation": "Creates an SSL/TLS certificate that secures traffic for your website. After the\n certificate is created, it is installed on the specified Lightsail instance.
\nIf you provide more than one domain name in the request, at least one name must be less\n than or equal to 63 characters in length.
", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/setup-instance-https", @@ -21488,7 +21506,7 @@ } }, "traits": { - "smithy.api#documentation": "Returns information that was submitted during the SetupInstanceHttps request. Email\n information is redacted for privacy.
Returns information that was submitted during the SetupInstanceHttps request.\n Email information is redacted for privacy.
The Amazon Resource Name (ARN) of the static IP (arn:aws:lightsail:us-east-2:123456789101:StaticIp/9cbb4a9e-f8e3-4dfe-b57e-12345EXAMPLE).
The Amazon Resource Name (ARN) of the static IP\n (arn:aws:lightsail:us-east-2:123456789101:StaticIp/9cbb4a9e-f8e3-4dfe-b57e-12345EXAMPLE).
The instance where the static IP is attached (Amazon_Linux-1GB-Ohio-1).
The instance where the static IP is attached\n (Amazon_Linux-1GB-Ohio-1).
Use this parameter to update the minimum TLS protocol version for the SSL/TLS certificate that's attached to the distribution.
" + "smithy.api#documentation": "Use this parameter to update the minimum TLS protocol version for the SSL/TLS certificate\n that's attached to the distribution.
" } }, "certificateName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "The name of the SSL/TLS certificate that you want to attach to the distribution.
\nOnly certificates with a status of ISSUED can be attached to a distribution.
Use the GetCertificates action to get a list of certificate names that you can specify.
" + "smithy.api#documentation": "The name of the SSL/TLS certificate that you want to attach to the distribution.
\nOnly certificates with a status of ISSUED can be attached to a\n distribution.
Use the GetCertificates\n action to get a list of certificate names that you can specify.
" } }, "useDefaultCertificate": { "target": "com.amazonaws.lightsail#boolean", "traits": { - "smithy.api#documentation": "Indicates whether the default SSL/TLS certificate is attached to the distribution. The default value is true. When true, the distribution uses the default domain name such as d111111abcdef8.cloudfront.net.
Set this value to false to attach a new certificate to the distribution.
Indicates whether the default SSL/TLS certificate is attached to the distribution. The\n default value is true. When true, the distribution uses the default\n domain name such as d111111abcdef8.cloudfront.net.
Set this value to false to attach a new certificate to the\n distribution.
The name of the load balancer that you want to modify (my-load-balancer.
The name of the load balancer that you want to modify\n (my-load-balancer.