View a markdown version of this page

LightsailDistributionSubdomain - Amazon Lightsail
ContentsSee Also

LightsailDistributionSubdomain

Describes the Lightsail subdomain of a distribution. The distribution is reachable at the subdomain's web address, which is the subdomain followed by amazonlightsail.com.

Contents

name

The subdomain (for example, mysite), not its web address.

Type: String

Required: Yes

state

The state of the subdomain for the distribution.

The following states are possible:

  • Creating – The subdomain is being created.

  • Attaching – The subdomain is being associated with the distribution.

  • Attached – The subdomain is associated with the distribution.

  • Error – The subdomain couldn't be created or associated with the distribution. For more information, see the errorCode and errorDetails parameters.

Type: String

Valid Values: Creating | Attaching | Attached | Error

Required: Yes

errorCode

The error code that describes why the subdomain is in the Error state.

Type: String

Required: No

errorDetails

The details of the error that caused the subdomain to be in the Error state.

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: