Interface CreateGatewayRouteRequest.Builder

All Superinterfaces:
AppMeshRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<CreateGatewayRouteRequest.Builder,CreateGatewayRouteRequest>, SdkBuilder<CreateGatewayRouteRequest.Builder,CreateGatewayRouteRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateGatewayRouteRequest
public static interface CreateGatewayRouteRequest.Builder extends AppMeshRequest.Builder, SdkPojo, CopyableBuilder<CreateGatewayRouteRequest.Builder,CreateGatewayRouteRequest>

  • Method Details

    • clientToken

      CreateGatewayRouteRequest.Builder clientToken(String clientToken)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

      Parameters:
      clientToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • gatewayRouteName

      CreateGatewayRouteRequest.Builder gatewayRouteName(String gatewayRouteName)

      The name to use for the gateway route.

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

    • meshName

      CreateGatewayRouteRequest.Builder meshName(String meshName)

      The name of the service mesh to create the gateway route in.

      Parameters:
      meshName - The name of the service mesh to create the gateway route in.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • meshOwner

      CreateGatewayRouteRequest.Builder meshOwner(String meshOwner)

      The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes.

      Parameters:
      meshOwner - The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • spec

      CreateGatewayRouteRequest.Builder spec(GatewayRouteSpec spec)

      The gateway route specification to apply.

      Parameters:
      spec - The gateway route specification to apply.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • spec

      default CreateGatewayRouteRequest.Builder spec(Consumer<GatewayRouteSpec.Builder> spec)

      The gateway route specification to apply.

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

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

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

    • tags

      CreateGatewayRouteRequest.Builder tags(Collection<TagRef> tags)

      Optional metadata that you can apply to the gateway route to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

      Parameters:
      tags - Optional metadata that you can apply to the gateway route to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateGatewayRouteRequest.Builder tags(TagRef... tags)

      Optional metadata that you can apply to the gateway route to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

      Parameters:
      tags - Optional metadata that you can apply to the gateway route to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateGatewayRouteRequest.Builder tags(Consumer<TagRef.Builder>... tags)

      Optional metadata that you can apply to the gateway route to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

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

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

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

    • virtualGatewayName

      CreateGatewayRouteRequest.Builder virtualGatewayName(String virtualGatewayName)

      The name of the virtual gateway to associate the gateway route with. If the virtual gateway is in a shared mesh, then you must be the owner of the virtual gateway resource.

      Parameters:
      virtualGatewayName - The name of the virtual gateway to associate the gateway route with. If the virtual gateway is in a shared mesh, then you must be the owner of the virtual gateway resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateGatewayRouteRequest.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

      CreateGatewayRouteRequest.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.