AWS CLI Command Reference

[ aws . lightsail ]

update-subdomain-association

Description

Associates a Lightsail subdomain with a resource, disassociates it from a resource, or moves it from one resource to another resource.

Currently, you can associate a subdomain only with a Lightsail content delivery network (CDN) distribution. A resource can be associated with only one subdomain at a time.

When you associate a subdomain with a distribution, Lightsail attaches the subdomain’s certificate to the distribution. You can’t associate a subdomain with a distribution that uses a custom domain, which is a distribution that has a Lightsail certificate attached.

You can transfer each subdomain to another resource only once in a 24-hour period.

The update is asynchronous. The response returns the subdomain in the ATTACHING , DETACHING , or TRANSFERRING state, and an operation. To check when the update is complete, use the GetSubdomains action.

See also: AWS API Documentation

Synopsis

  update-subdomain-association
--subdomain-name <value>
--action <value>
[--target-resource-arn <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
[--help]

Options

--subdomain-name (string) [required]

The subdomain to update (for example, mysite or blog.mysite ), not its web address.

--action (string) [required]

The association change to make.

The following actions are possible:

  • ASSOCIATE – Associates the subdomain with the resource that you specify in the targetResourceArn parameter. The subdomain must be in the UNATTACHED state.
  • DISASSOCIATE – Disassociates the subdomain from its current resource. The subdomain must be in the ATTACHED state.
  • TRANSFER – Moves the subdomain from its current resource to the resource that you specify in the targetResourceArn parameter. The subdomain must be in the ATTACHED state. You can transfer each subdomain only once in a 24-hour period.

Possible values:

  • ASSOCIATE
  • DISASSOCIATE
  • TRANSFER

--target-resource-arn (string)

The Amazon Resource Name (ARN) of the resource to associate the subdomain with. The resource must be in your account.

This parameter is required when the action is ASSOCIATE or TRANSFER . It’s ignored when the action is DISASSOCIATE .

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream
  • off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

--help (boolean)

Display help for the command/subcommand.

Output

subdomain -> (structure)

An object that describes the subdomain that was updated.

subdomainName -> (string)

The subdomain (for example, mysite or blog.mysite ). To get the web address, use the fqdn parameter.

arn -> (string)

The Amazon Resource Name (ARN) of the subdomain.

If you create a subdomain with a depth of 2, such as blog.mysite , without first creating the subdomain with a depth of 1 (mysite ), Lightsail holds mysite for your account in the IMPLICIT state. It doesn’t have an ARN until you create a subdomain with that name.

Constraints:

  • pattern: .*\S.*

fqdn -> (string)

The web address of the subdomain, which is the subdomain followed by amazonlightsail.com (for example, blog.mysite.amazonlightsail.com ).

depth -> (integer)

The number of labels in the subdomain. A top-level subdomain, such as mysite , has a depth of 1 . A nested subdomain, such as blog.mysite , has a depth of 2 .

state -> (string)

The state of the subdomain.

The following states are possible:

  • CREATING – The subdomain is being created.
  • CREATE_FAILED – The subdomain couldn’t be created. Delete the subdomain, and then create it again if the name is still available.
  • UNATTACHED – The subdomain is ready, and isn’t associated with a resource.
  • ATTACHING – The subdomain is being associated with a resource.
  • ATTACHED – The subdomain is associated with a resource, and routes traffic to it.
  • DETACHING – The subdomain is being disassociated from a resource.
  • TRANSFERRING – The subdomain is being moved from one resource to another resource.
  • IMPLICIT – The subdomain is the parent of one or more nested subdomains that you created, but you didn’t create the parent subdomain itself. You can’t associate or delete a subdomain in this state. To use it, create it with the CreateSubdomain action.

Possible values:

  • CREATING
  • CREATE_FAILED
  • UNATTACHED
  • ATTACHING
  • ATTACHED
  • DETACHING
  • TRANSFERRING
  • IMPLICIT

attachedResource -> (structure)

An object that describes the resource that the subdomain is associated with.

When the subdomain is in the TRANSFERRING state, this is the resource that the subdomain is being moved from.

arn -> (string)

The Amazon Resource Name (ARN) of the resource.

Constraints:

  • pattern: .*\S.*

name -> (string)

The name of the resource.

Constraints:

  • pattern: \w[\w\-]*\w

attachedAt -> (timestamp)

The timestamp when the subdomain was associated with the resource.

attachingResource -> (structure)

An object that describes the resource that the subdomain is being associated with.

This parameter is returned only when the subdomain is in the ATTACHING or TRANSFERRING state.

arn -> (string)

The Amazon Resource Name (ARN) of the resource.

Constraints:

  • pattern: .*\S.*

name -> (string)

The name of the resource.

Constraints:

  • pattern: \w[\w\-]*\w

attachedAt -> (timestamp)

The timestamp when the subdomain was associated with the resource.

location -> (structure)

An object that describes the location of the subdomain, such as the AWS Region.

availabilityZone -> (string)

The Availability Zone. Follows the format us-east-2a (case-sensitive).

regionName -> (string)

The Amazon Web Services Region name.

Possible values:

  • us-east-1
  • us-east-2
  • us-west-1
  • us-west-2
  • eu-west-1
  • eu-west-2
  • eu-west-3
  • eu-central-1
  • eu-north-1
  • eu-south-2
  • ca-central-1
  • ap-east-1
  • ap-south-1
  • ap-southeast-1
  • ap-southeast-2
  • ap-northeast-1
  • ap-northeast-2
  • ap-southeast-3
  • ap-southeast-5
  • sa-east-1

createdAt -> (timestamp)

The timestamp when the subdomain was created.

parentFqdn -> (string)

The web address of the parent subdomain (for example, mysite.amazonlightsail.com for blog.mysite ).

This parameter isn’t returned for a subdomain with a depth of 1.

children -> (list)

An array of objects that describe the nested subdomains of the subdomain.

This parameter is returned only by the GetSubdomains action when you don’t specify a subdomain.

(structure)

Describes a Lightsail subdomain. A subdomain is the name that you choose, such as mysite or blog.mysite . Its web address is the subdomain followed by amazonlightsail.com , such as blog.mysite.amazonlightsail.com . You can associate a subdomain with a Lightsail resource to make the resource reachable at the web address.

subdomainName -> (string)

The subdomain (for example, mysite or blog.mysite ). To get the web address, use the fqdn parameter.

arn -> (string)

The Amazon Resource Name (ARN) of the subdomain.

If you create a subdomain with a depth of 2, such as blog.mysite , without first creating the subdomain with a depth of 1 (mysite ), Lightsail holds mysite for your account in the IMPLICIT state. It doesn’t have an ARN until you create a subdomain with that name.

Constraints:

  • pattern: .*\S.*

fqdn -> (string)

The web address of the subdomain, which is the subdomain followed by amazonlightsail.com (for example, blog.mysite.amazonlightsail.com ).

depth -> (integer)

The number of labels in the subdomain. A top-level subdomain, such as mysite , has a depth of 1 . A nested subdomain, such as blog.mysite , has a depth of 2 .

state -> (string)

The state of the subdomain.

The following states are possible:

  • CREATING – The subdomain is being created.
  • CREATE_FAILED – The subdomain couldn’t be created. Delete the subdomain, and then create it again if the name is still available.
  • UNATTACHED – The subdomain is ready, and isn’t associated with a resource.
  • ATTACHING – The subdomain is being associated with a resource.
  • ATTACHED – The subdomain is associated with a resource, and routes traffic to it.
  • DETACHING – The subdomain is being disassociated from a resource.
  • TRANSFERRING – The subdomain is being moved from one resource to another resource.
  • IMPLICIT – The subdomain is the parent of one or more nested subdomains that you created, but you didn’t create the parent subdomain itself. You can’t associate or delete a subdomain in this state. To use it, create it with the CreateSubdomain action.

Possible values:

  • CREATING
  • CREATE_FAILED
  • UNATTACHED
  • ATTACHING
  • ATTACHED
  • DETACHING
  • TRANSFERRING
  • IMPLICIT

attachedResource -> (structure)

An object that describes the resource that the subdomain is associated with.

When the subdomain is in the TRANSFERRING state, this is the resource that the subdomain is being moved from.

arn -> (string)

The Amazon Resource Name (ARN) of the resource.

Constraints:

  • pattern: .*\S.*

name -> (string)

The name of the resource.

Constraints:

  • pattern: \w[\w\-]*\w

attachedAt -> (timestamp)

The timestamp when the subdomain was associated with the resource.

attachingResource -> (structure)

An object that describes the resource that the subdomain is being associated with.

This parameter is returned only when the subdomain is in the ATTACHING or TRANSFERRING state.

arn -> (string)

The Amazon Resource Name (ARN) of the resource.

Constraints:

  • pattern: .*\S.*

name -> (string)

The name of the resource.

Constraints:

  • pattern: \w[\w\-]*\w

attachedAt -> (timestamp)

The timestamp when the subdomain was associated with the resource.

location -> (structure)

An object that describes the location of the subdomain, such as the AWS Region.

availabilityZone -> (string)

The Availability Zone. Follows the format us-east-2a (case-sensitive).

regionName -> (string)

The Amazon Web Services Region name.

Possible values:

  • us-east-1
  • us-east-2
  • us-west-1
  • us-west-2
  • eu-west-1
  • eu-west-2
  • eu-west-3
  • eu-central-1
  • eu-north-1
  • eu-south-2
  • ca-central-1
  • ap-east-1
  • ap-south-1
  • ap-southeast-1
  • ap-southeast-2
  • ap-northeast-1
  • ap-northeast-2
  • ap-southeast-3
  • ap-southeast-5
  • sa-east-1

createdAt -> (timestamp)

The timestamp when the subdomain was created.

parentFqdn -> (string)

The web address of the parent subdomain (for example, mysite.amazonlightsail.com for blog.mysite ).

This parameter isn’t returned for a subdomain with a depth of 1.

children -> (list)

An array of objects that describe the nested subdomains of the subdomain.

This parameter is returned only by the GetSubdomains action when you don’t specify a subdomain.

( … recursive … )

tags -> (list)

The tag keys and optional values for the subdomain. For more information about tags in Lightsail, see the Lightsail Developer Guide .

This parameter is returned only by the GetSubdomains action when you specify a subdomain.

(structure)

Describes a tag key and optional value assigned to an Amazon Lightsail resource.

For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide .

key -> (string)

The key of the tag.

Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @

value -> (string)

The value of the tag.

Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @

tags -> (list)

The tag keys and optional values for the subdomain. For more information about tags in Lightsail, see the Lightsail Developer Guide .

This parameter is returned only by the GetSubdomains action when you specify a subdomain.

(structure)

Describes a tag key and optional value assigned to an Amazon Lightsail resource.

For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide .

key -> (string)

The key of the tag.

Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @

value -> (string)

The value of the tag.

Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @

operation -> (structure)

An object that describes the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

id -> (string)

The ID of the operation.

Constraints:

  • pattern: .*\S.*

resourceName -> (string)

The resource name.

Constraints:

  • pattern: \w[\w\-]*\w

resourceType -> (string)

The resource type.

Possible values:

  • ContainerService
  • Instance
  • StaticIp
  • KeyPair
  • InstanceSnapshot
  • Domain
  • PeeredVpc
  • LoadBalancer
  • LoadBalancerTlsCertificate
  • Disk
  • DiskSnapshot
  • RelationalDatabase
  • RelationalDatabaseSnapshot
  • ExportSnapshotRecord
  • CloudFormationStackRecord
  • Alarm
  • ContactMethod
  • Distribution
  • Certificate
  • Bucket
  • Subdomain

createdAt -> (timestamp)

The timestamp when the operation was initialized (1479816991.349 ).

location -> (structure)

The Amazon Web Services Region and Availability Zone.

availabilityZone -> (string)

The Availability Zone. Follows the format us-east-2a (case-sensitive).

regionName -> (string)

The Amazon Web Services Region name.

Possible values:

  • us-east-1
  • us-east-2
  • us-west-1
  • us-west-2
  • eu-west-1
  • eu-west-2
  • eu-west-3
  • eu-central-1
  • eu-north-1
  • eu-south-2
  • ca-central-1
  • ap-east-1
  • ap-south-1
  • ap-southeast-1
  • ap-southeast-2
  • ap-northeast-1
  • ap-northeast-2
  • ap-southeast-3
  • ap-southeast-5
  • sa-east-1

isTerminal -> (boolean)

A Boolean value indicating whether the operation is terminal.

operationDetails -> (string)

Details about the operation (Debian-1GB-Ohio-1 ).

operationType -> (string)

The type of operation.

Possible values:

  • DeleteKnownHostKeys
  • DeleteInstance
  • CreateInstance
  • StopInstance
  • StartInstance
  • RebootInstance
  • OpenInstancePublicPorts
  • PutInstancePublicPorts
  • CloseInstancePublicPorts
  • AllocateStaticIp
  • ReleaseStaticIp
  • AttachStaticIp
  • DetachStaticIp
  • UpdateDomainEntry
  • DeleteDomainEntry
  • CreateDomain
  • DeleteDomain
  • CreateInstanceSnapshot
  • DeleteInstanceSnapshot
  • CreateInstancesFromSnapshot
  • CreateLoadBalancer
  • DeleteLoadBalancer
  • AttachInstancesToLoadBalancer
  • DetachInstancesFromLoadBalancer
  • UpdateLoadBalancerAttribute
  • CreateLoadBalancerTlsCertificate
  • DeleteLoadBalancerTlsCertificate
  • AttachLoadBalancerTlsCertificate
  • CreateDisk
  • DeleteDisk
  • AttachDisk
  • DetachDisk
  • CreateDiskSnapshot
  • DeleteDiskSnapshot
  • CreateDiskFromSnapshot
  • CreateRelationalDatabase
  • UpdateRelationalDatabase
  • DeleteRelationalDatabase
  • CreateRelationalDatabaseFromSnapshot
  • CreateRelationalDatabaseSnapshot
  • DeleteRelationalDatabaseSnapshot
  • UpdateRelationalDatabaseParameters
  • StartRelationalDatabase
  • RebootRelationalDatabase
  • StopRelationalDatabase
  • EnableAddOn
  • DisableAddOn
  • PutAlarm
  • GetAlarms
  • DeleteAlarm
  • TestAlarm
  • CreateContactMethod
  • GetContactMethods
  • SendContactMethodVerification
  • DeleteContactMethod
  • CreateDistribution
  • UpdateDistribution
  • DeleteDistribution
  • ResetDistributionCache
  • AttachCertificateToDistribution
  • DetachCertificateFromDistribution
  • UpdateDistributionBundle
  • SetIpAddressType
  • CreateCertificate
  • DeleteCertificate
  • CreateContainerService
  • UpdateContainerService
  • DeleteContainerService
  • CreateContainerServiceDeployment
  • CreateContainerServiceRegistryLogin
  • RegisterContainerImage
  • DeleteContainerImage
  • CreateBucket
  • DeleteBucket
  • CreateBucketAccessKey
  • DeleteBucketAccessKey
  • UpdateBucketBundle
  • UpdateBucket
  • SetResourceAccessForBucket
  • UpdateInstanceMetadataOptions
  • StartGUISession
  • StopGUISession
  • SetupInstanceHttps
  • GetProfile
  • CreateSubdomain
  • UpdateSubdomainAssociation
  • DeleteSubdomain

status -> (string)

The status of the operation.

Possible values:

  • NotStarted
  • Started
  • Failed
  • Completed
  • Succeeded

statusChangedAt -> (timestamp)

The timestamp when the status was changed (1479816991.349 ).

errorCode -> (string)

The error code.

errorDetails -> (string)

The error details.
© Copyright 2026, Amazon Web Services. Created using Sphinx.