Interface CreateGatewayRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateGatewayRequest.Builder,CreateGatewayRequest>, EcsRequest.Builder, SdkBuilder<CreateGatewayRequest.Builder,CreateGatewayRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateGatewayRequest
@Mutable @NotThreadSafe public static interface CreateGatewayRequest.Builder extends EcsRequest.Builder, SdkPojo, CopyableBuilder<CreateGatewayRequest.Builder,CreateGatewayRequest>

  • Method Details

    • name

      CreateGatewayRequest.Builder name(String name)

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

      Parameters:
      name - The name for the gateway. The name must be unique within your account and can be up to 255 characters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • infrastructureRoleArn

      CreateGatewayRequest.Builder infrastructureRoleArn(String infrastructureRoleArn)

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

      Parameters:
      infrastructureRoleArn - The Amazon Resource Name (ARN) of the IAM role that the gateway assumes to create and manage infrastructure on your behalf.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      CreateGatewayRequest.Builder clientToken(String clientToken)

      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.

      Parameters:
      clientToken - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deletionProtection

      CreateGatewayRequest.Builder deletionProtection(Boolean deletionProtection)

      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.

      Parameters:
      deletionProtection - 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:
      Returns a reference to this object so that method calls can be chained together.

    • configuration

      CreateGatewayRequest.Builder configuration(GatewayConfiguration configuration)

      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.

      Parameters:
      configuration - 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:
      Returns a reference to this object so that method calls can be chained together.

    • configuration

      default CreateGatewayRequest.Builder configuration(Consumer<GatewayConfiguration.Builder> configuration)

      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.

      This is a convenience method that creates an instance of the GatewayConfiguration.Builder avoiding the need to create one manually via GatewayConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to configuration(GatewayConfiguration).

      Parameters:
      configuration - a consumer that will call methods on GatewayConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

      CreateGatewayRequest.Builder tags(Collection<Tag> tags)

      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.

      Parameters:
      tags - 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:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateGatewayRequest.Builder tags(Tag... tags)

      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.

      Parameters:
      tags - 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:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateGatewayRequest.Builder tags(Consumer<Tag.Builder>... tags)

      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.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • propagateTags

      CreateGatewayRequest.Builder propagateTags(String propagateTags)

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

      Parameters:
      propagateTags - Specifies whether to propagate the tags from the gateway to the infrastructure that the gateway manages. The default is GATEWAY.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • propagateTags

      CreateGatewayRequest.Builder propagateTags(PropagateGatewayTags propagateTags)

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

      Parameters:
      propagateTags - Specifies whether to propagate the tags from the gateway to the infrastructure that the gateway manages. The default is GATEWAY.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CreateGatewayRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateGatewayRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.