You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::AppMesh::Types::CreateGatewayRouteInput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateGatewayRouteInput as input to an Aws::Client method, you can use a vanilla Hash:

{
  client_token: "String",
  gateway_route_name: "ResourceName", # required
  mesh_name: "ResourceName", # required
  mesh_owner: "AccountId",
  spec: { # required
    grpc_route: {
      action: { # required
        target: { # required
          virtual_service: { # required
            virtual_service_name: "ResourceName", # required
          },
        },
      },
      match: { # required
        service_name: "ServiceName",
      },
    },
    http2_route: {
      action: { # required
        target: { # required
          virtual_service: { # required
            virtual_service_name: "ResourceName", # required
          },
        },
      },
      match: { # required
        prefix: "String", # required
      },
    },
    http_route: {
      action: { # required
        target: { # required
          virtual_service: { # required
            virtual_service_name: "ResourceName", # required
          },
        },
      },
      match: { # required
        prefix: "String", # required
      },
    },
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  virtual_gateway_name: "ResourceName", # required
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

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:

  • (String) —

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

#gateway_route_name ⇒ String

The name to use for the gateway route.

Returns:

  • (String) —

    The name to use for the gateway route.

#mesh_name ⇒ String

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

Returns:

  • (String) —

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

#mesh_owner ⇒ String

The AWS 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:

  • (String) —

    The AWS IAM account ID of the service mesh owner.

#spec ⇒ Types::GatewayRouteSpec

The gateway route specification to apply.

Returns:

#tags ⇒ Array<Types::TagRef>

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:

  • (Array<Types::TagRef>) —

    Optional metadata that you can apply to the gateway route to assist with categorization and organization.

#virtual_gateway_name ⇒ String

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:

  • (String) —

    The name of the virtual gateway to associate the gateway route with.