Gateway

The details of a gateway, including its configuration, status, and the infrastructure settings for its type.

accessType

Specifies whether the gateway is publicly accessible (PUBLIC) or private (PRIVATE). The gateway derives this value from its scheme when you create the gateway, and the value is immutable.

Type: String

Valid Values: PUBLIC | PRIVATE

Required: No

configuration

The type-specific configuration for the gateway.

Type: DescribeGatewayConfiguration object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

createdAt

The Unix timestamp for the time when the gateway was created.

Type: Timestamp

Required: No

deletionProtection

Specifies whether deletion protection is enabled for the gateway.

Type: Boolean

Required: No

failures

The per-resource failure details for asynchronous gateway processes, such as an UpdateGateway operation that couldn't update every load balancer.

Type: Array of GatewayResourceFailure objects

Array Members: Minimum number of 0 items. Maximum number of 200 items.

Required: No

gatewayArn

The Amazon Resource Name (ARN) of the gateway.

Type: String

Required: No

infrastructureRoleArn

The Amazon Resource Name (ARN) of the IAM role that the gateway uses to manage infrastructure on your behalf.

Type: String

Required: No

name

The name of the gateway.

Type: String

Required: No

propagateTags

Specifies whether the gateway propagates its tags to the infrastructure it manages.

Type: String

Valid Values: NONE | GATEWAY

Required: No

status

The status of the gateway.

Type: String

Valid Values: ACTIVE | UPDATE_IN_PROGRESS | UPDATE_COMPLETE | UPDATE_FAILED | DELETED

Required: No

statusReason

A human-readable explanation of the current status. This value is populated when the gateway is in a failure state, such as UPDATE_FAILED.

Type: String

Required: No

tags

The metadata applied to the gateway. Each tag consists of a key and an optional value.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Required: No

updatedAt

The Unix timestamp for the time when the gateway was last updated.

Type: Timestamp

Required: No

Gateway

Contents

See Also