Interface Gateway.Builder

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

  • Method Details

    • gatewayArn

      Gateway.Builder gatewayArn(String gatewayArn)

      The Amazon Resource Name (ARN) of the gateway.

      Parameters:
      gatewayArn - The Amazon Resource Name (ARN) of the gateway.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      Gateway.Builder name(String name)

      The name of the gateway.

      Parameters:
      name - The name of the gateway.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      Gateway.Builder status(String status)

      The status of the gateway.

      Parameters:
      status - The status of the gateway.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      Gateway.Builder status(GatewayStatus status)

      The status of the gateway.

      Parameters:
      status - The status of the gateway.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • statusReason

      Gateway.Builder statusReason(String 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.

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

    • failures

      Gateway.Builder failures(Collection<GatewayResourceFailure> failures)

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

      Parameters:
      failures - The per-resource failure details for asynchronous gateway processes, such as an UpdateGateway operation that couldn't update every load balancer.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • failures

      Gateway.Builder failures(GatewayResourceFailure... failures)

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

      Parameters:
      failures - The per-resource failure details for asynchronous gateway processes, such as an UpdateGateway operation that couldn't update every load balancer.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • failures

      Gateway.Builder failures(Consumer<GatewayResourceFailure.Builder>... failures)

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

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

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

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

    • infrastructureRoleArn

      Gateway.Builder infrastructureRoleArn(String infrastructureRoleArn)

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

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

    • deletionProtection

      Gateway.Builder deletionProtection(Boolean deletionProtection)

      Specifies whether deletion protection is enabled for the gateway.

      Parameters:
      deletionProtection - Specifies whether deletion protection is enabled for the gateway.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • configuration

      Gateway.Builder configuration(DescribeGatewayConfiguration configuration)

      The type-specific configuration for the gateway.

      Parameters:
      configuration - The type-specific configuration for the gateway.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • configuration

      default Gateway.Builder configuration(Consumer<DescribeGatewayConfiguration.Builder> configuration)

      The type-specific configuration for the gateway.

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

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

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

    • accessType

      Gateway.Builder accessType(String 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.

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

    • accessType

      Gateway.Builder accessType(AccessType 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.

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

    • propagateTags

      Gateway.Builder propagateTags(String propagateTags)

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

      Parameters:
      propagateTags - Specifies whether the gateway propagates its tags to the infrastructure it manages.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • propagateTags

      Gateway.Builder propagateTags(PropagateGatewayTags propagateTags)

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

      Parameters:
      propagateTags - Specifies whether the gateway propagates its tags to the infrastructure it manages.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

      Gateway.Builder tags(Collection<Tag> tags)

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

      Parameters:
      tags - The metadata applied to the gateway. Each tag consists of a key and an optional value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      Gateway.Builder tags(Tag... tags)

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

      Parameters:
      tags - The metadata applied to the gateway. Each tag consists of a key and an optional value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

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

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

      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:

    • createdAt

      Gateway.Builder createdAt(Instant createdAt)

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

      Parameters:
      createdAt - The Unix timestamp for the time when the gateway was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • updatedAt

      Gateway.Builder updatedAt(Instant updatedAt)

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

      Parameters:
      updatedAt - The Unix timestamp for the time when the gateway was last updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.