Class: Aws::ECS::Types::CreateGatewayRequest

Inherits:

Struct

• Object
• Struct
• Aws::ECS::Types::CreateGatewayRequest

Defined in:

gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_token ⇒ String

  A unique, case-sensitive identifier that you provide to ensure that the operation completes no more than one time.

• #configuration ⇒ Types::GatewayConfiguration

  The type-specific configuration for the gateway.

• #deletion_protection ⇒ Boolean

  Specifies whether to enable deletion protection for the gateway.

• #infrastructure_role_arn ⇒ String

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

• #name ⇒ String

  The name for the gateway.

• #propagate_tags ⇒ String

  Specifies whether to propagate the tags from the gateway to the infrastructure that the gateway manages.

• #tags ⇒ Array<Types::Tag>

  The metadata that you apply to the gateway to help you categorize and organize it.

Instance Attribute Details

#client_token ⇒ String

A unique, case-sensitive identifier that you provide to ensure that the operation completes no more than one time. If this token matches a previous request, the service ignores the request, but does not return an error.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

• (String)

# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3478

class CreateGatewayRequest < Struct.new(
  :name,
  :infrastructure_role_arn,
  :client_token,
  :deletion_protection,
  :configuration,
  :tags,
  :propagate_tags)
  SENSITIVE = []
  include Aws::Structure
end

#configuration ⇒ Types::GatewayConfiguration

The type-specific configuration for the gateway. Exactly one configuration variant must be set, and it determines the gateway type. For example, hostSharedAlb configures a gateway that uses Application Load Balancers with host-based routing.

Returns:

• (Types::GatewayConfiguration)

# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3478

class CreateGatewayRequest < Struct.new(
  :name,
  :infrastructure_role_arn,
  :client_token,
  :deletion_protection,
  :configuration,
  :tags,
  :propagate_tags)
  SENSITIVE = []
  include Aws::Structure
end

#deletion_protection ⇒ Boolean

Specifies whether to enable deletion protection for the gateway. When enabled, the gateway can't be deleted, and the gateway propagates this setting to the load balancers it manages. The default is true.

Returns:

• (Boolean)

# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3478

class CreateGatewayRequest < Struct.new(
  :name,
  :infrastructure_role_arn,
  :client_token,
  :deletion_protection,
  :configuration,
  :tags,
  :propagate_tags)
  SENSITIVE = []
  include Aws::Structure
end

#infrastructure_role_arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3478

class CreateGatewayRequest < Struct.new(
  :name,
  :infrastructure_role_arn,
  :client_token,
  :deletion_protection,
  :configuration,
  :tags,
  :propagate_tags)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name for the gateway. The name must be unique within your account and can be up to 255 characters.

Returns:

• (String)

# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3478

class CreateGatewayRequest < Struct.new(
  :name,
  :infrastructure_role_arn,
  :client_token,
  :deletion_protection,
  :configuration,
  :tags,
  :propagate_tags)
  SENSITIVE = []
  include Aws::Structure
end

#propagate_tags ⇒ String

Specifies whether to propagate the tags from the gateway to the infrastructure that the gateway manages. The default is GATEWAY.

Returns:

• (String)

# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3478

class CreateGatewayRequest < Struct.new(
  :name,
  :infrastructure_role_arn,
  :client_token,
  :deletion_protection,
  :configuration,
  :tags,
  :propagate_tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

The metadata that you apply to the gateway to help you categorize and organize it. Each tag consists of a key and an optional value. Depending on propagateTags, these tags can be applied to the infrastructure the gateway manages.

Returns:

• (Array<Types::Tag>)

# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3478

class CreateGatewayRequest < Struct.new(
  :name,
  :infrastructure_role_arn,
  :client_token,
  :deletion_protection,
  :configuration,
  :tags,
  :propagate_tags)
  SENSITIVE = []
  include Aws::Structure
end