Sponsoring The Perl Toolchain Summit 2025: Help make this important event another success Learn more

 / 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::AppMesh::CreateGatewayRoute

NAME

Paws::AppMesh::CreateGatewayRoute - Arguments for method CreateGatewayRoute on Paws::AppMesh

DESCRIPTION

This class represents the parameters used for calling the method CreateGatewayRoute on the AWS App Mesh service. Use the attributes of this class as arguments to method CreateGatewayRoute.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateGatewayRoute.

SYNOPSIS


            

              
              
my $appmesh = Paws->service('AppMesh');
my $CreateGatewayRouteOutput = $appmesh->CreateGatewayRoute(
  GatewayRouteName => 'MyResourceName',
  MeshName         => 'MyResourceName',
  Spec             => {
    GrpcRoute => {
      Action => {
        Target => {
          VirtualService => {
            VirtualServiceName => 'MyResourceName',    # min: 1, max: 255
          },
        },
        Rewrite => {
          Hostname => {
            DefaultTargetHostname =>
              'ENABLED',    # values: ENABLED, DISABLED; OPTIONAL
          },    # OPTIONAL
        },    # OPTIONAL
      },
      Match => {
        Hostname => {
          Exact  => 'MyExactHostName',     # min: 1, max: 253; OPTIONAL
          Suffix => 'MySuffixHostname',    # min: 1, max: 253; OPTIONAL
        },    # OPTIONAL
        Metadata => [
          {
            Name   => 'MyHeaderName',    # min: 1, max: 50
            Invert => 1,                 # OPTIONAL
            Match  => {
              Exact  => 'MyHeaderMatch',    # min: 1, max: 255; OPTIONAL
              Prefix => 'MyHeaderMatch',    # min: 1, max: 255; OPTIONAL
              Range  => {
                End   => 1,
                Start => 1,
              },                            # OPTIONAL
              Regex  => 'MyHeaderMatch',    # min: 1, max: 255; OPTIONAL
              Suffix => 'MyHeaderMatch',    # min: 1, max: 255; OPTIONAL
            },    # OPTIONAL
          },
          ...
        ],    # min: 1, max: 10; OPTIONAL
        ServiceName => 'MyServiceName',    # OPTIONAL
      },
    },    # OPTIONAL
    Http2Route => {
      Action => {
        Target => {
          VirtualService => {
            VirtualServiceName => 'MyResourceName',    # min: 1, max: 255
          },
        },
        Rewrite => {
          Hostname => {
            DefaultTargetHostname =>
              'ENABLED',    # values: ENABLED, DISABLED; OPTIONAL
          },    # OPTIONAL
          Path => {
            Exact => 'MyHttpPathExact',    # min: 1, max: 255; OPTIONAL
          },    # OPTIONAL
          Prefix => {
            DefaultPrefix =>
              'ENABLED',    # values: ENABLED, DISABLED; OPTIONAL
            Value =>
              'MyHttpGatewayRoutePrefix',    # min: 1, max: 255; OPTIONAL
          },    # OPTIONAL
        },    # OPTIONAL
      },
      Match => {
        Headers => [
          {
            Name   => 'MyHeaderName',    # min: 1, max: 50
            Invert => 1,                 # OPTIONAL
            Match  => {
              Exact  => 'MyHeaderMatch',    # min: 1, max: 255; OPTIONAL
              Prefix => 'MyHeaderMatch',    # min: 1, max: 255; OPTIONAL
              Range  => {
                End   => 1,
                Start => 1,
              },                            # OPTIONAL
              Regex  => 'MyHeaderMatch',    # min: 1, max: 255; OPTIONAL
              Suffix => 'MyHeaderMatch',    # min: 1, max: 255; OPTIONAL
            },    # OPTIONAL
          },
          ...
        ],    # min: 1, max: 10; OPTIONAL
        Hostname => {
          Exact  => 'MyExactHostName',     # min: 1, max: 253; OPTIONAL
          Suffix => 'MySuffixHostname',    # min: 1, max: 253; OPTIONAL
        },    # OPTIONAL
        Method => 'GET'
        , # values: GET, HEAD, POST, PUT, DELETE, CONNECT, OPTIONS, TRACE, PATCH; OPTIONAL
        Path => {
          Exact => 'MyHttpPathExact',    # min: 1, max: 255; OPTIONAL
          Regex => 'MyHttpPathRegex',    # min: 1, max: 255; OPTIONAL
        },    # OPTIONAL
        Prefix          => 'MyString',    # OPTIONAL
        QueryParameters => [
          {
            Name  => 'MyQueryParameterName',
            Match => {
              Exact => 'MyString',    # OPTIONAL
            },    # OPTIONAL
          },
          ...
        ],    # min: 1, max: 10; OPTIONAL
      },
    },    # OPTIONAL
    HttpRoute => {
      Action => {
        Target => {
          VirtualService => {
            VirtualServiceName => 'MyResourceName',    # min: 1, max: 255
          },
        },
        Rewrite => {
          Hostname => {
            DefaultTargetHostname =>
              'ENABLED',    # values: ENABLED, DISABLED; OPTIONAL
          },    # OPTIONAL
          Path => {
            Exact => 'MyHttpPathExact',    # min: 1, max: 255; OPTIONAL
          },    # OPTIONAL
          Prefix => {
            DefaultPrefix =>
              'ENABLED',    # values: ENABLED, DISABLED; OPTIONAL
            Value =>
              'MyHttpGatewayRoutePrefix',    # min: 1, max: 255; OPTIONAL
          },    # OPTIONAL
        },    # OPTIONAL
      },
      Match => {
        Headers => [
          {
            Name   => 'MyHeaderName',    # min: 1, max: 50
            Invert => 1,                 # OPTIONAL
            Match  => {
              Exact  => 'MyHeaderMatch',    # min: 1, max: 255; OPTIONAL
              Prefix => 'MyHeaderMatch',    # min: 1, max: 255; OPTIONAL
              Range  => {
                End   => 1,
                Start => 1,
              },                            # OPTIONAL
              Regex  => 'MyHeaderMatch',    # min: 1, max: 255; OPTIONAL
              Suffix => 'MyHeaderMatch',    # min: 1, max: 255; OPTIONAL
            },    # OPTIONAL
          },
          ...
        ],    # min: 1, max: 10; OPTIONAL
        Hostname => {
          Exact  => 'MyExactHostName',     # min: 1, max: 253; OPTIONAL
          Suffix => 'MySuffixHostname',    # min: 1, max: 253; OPTIONAL
        },    # OPTIONAL
        Method => 'GET'
        , # values: GET, HEAD, POST, PUT, DELETE, CONNECT, OPTIONS, TRACE, PATCH; OPTIONAL
        Path => {
          Exact => 'MyHttpPathExact',    # min: 1, max: 255; OPTIONAL
          Regex => 'MyHttpPathRegex',    # min: 1, max: 255; OPTIONAL
        },    # OPTIONAL
        Prefix          => 'MyString',    # OPTIONAL
        QueryParameters => [
          {
            Name  => 'MyQueryParameterName',
            Match => {
              Exact => 'MyString',    # OPTIONAL
            },    # OPTIONAL
          },
          ...
        ],    # min: 1, max: 10; OPTIONAL
      },
    },    # OPTIONAL
    Priority => 1,    # max: 1000; OPTIONAL
  },
  VirtualGatewayName => 'MyResourceName',
  ClientToken        => 'MyString',         # OPTIONAL
  MeshOwner          => 'MyAccountId',      # OPTIONAL
  Tags               => [
    {
      Key   => 'MyTagKey',      # min: 1, max: 128
      Value => 'MyTagValue',    # max: 256
    },
    ...
  ],    # OPTIONAL
);
# Results:
my $GatewayRoute = $CreateGatewayRouteOutput->GatewayRoute;
# Returns a L<Paws::AppMesh::CreateGatewayRouteOutput> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/appmesh/CreateGatewayRoute

ATTRIBUTES

ClientToken => Str

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

REQUIRED GatewayRouteName => Str

The name to use for the gateway route.

REQUIRED MeshName => Str

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

MeshOwner => Str

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 (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html).

REQUIRED Spec => Paws::AppMesh::GatewayRouteSpec

The gateway route specification to apply.

Tags => ArrayRef[Paws::AppMesh::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.

REQUIRED VirtualGatewayName => Str

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.

SEE ALSO

This class forms part of Paws, documenting arguments for method CreateGatewayRoute in Paws::AppMesh

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues