Skip to content

ECS  >  Structures  >  Gateway

Gateway

Structure Class

Gateway dataclass

Bases: _SerdeShape

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

Attributes

access_type class-attribute instance-attribute
access_type: str | None = ...

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.

configuration class-attribute instance-attribute
configuration: DescribeGatewayConfiguration | None = ...

The type-specific configuration for the gateway.

created_at class-attribute instance-attribute
created_at: datetime | None = ...

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

deletion_protection class-attribute instance-attribute
deletion_protection: bool | None = ...

Specifies whether deletion protection is enabled for the gateway.

failures class-attribute instance-attribute
failures: list[GatewayResourceFailure] | None = ...

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

gateway_arn class-attribute instance-attribute
gateway_arn: str | None = ...

The Amazon Resource Name (ARN) of the gateway.

infrastructure_role_arn class-attribute instance-attribute
infrastructure_role_arn: str | None = ...

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

name class-attribute instance-attribute
name: str | None = ...

The name of the gateway.

propagate_tags class-attribute instance-attribute
propagate_tags: str | None = ...

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

status class-attribute instance-attribute
status: str | None = ...

The status of the gateway.

status_reason class-attribute instance-attribute
status_reason: str | None = ...

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

tags class-attribute instance-attribute
tags: list[Tag] | None = ...

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

updated_at class-attribute instance-attribute
updated_at: datetime | None = ...

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