« blib/lib/Paws/AppMesh/ClientTlsCertificate.pm
↑ Summary
blib/lib/Paws/AppMesh/CreateGatewayRouteOutput.pm »
| 1 | |||
| 2 | package Paws::AppMesh::CreateGatewayRoute; | ||
| 3 | use Moose; | ||
| 4 | has ClientToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'clientToken'); | ||
| 5 | has GatewayRouteName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'gatewayRouteName', required => 1); | ||
| 6 | has MeshName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'meshName', required => 1); | ||
| 7 | has MeshOwner => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'meshOwner'); | ||
| 8 | has Spec => (is => 'ro', isa => 'Paws::AppMesh::GatewayRouteSpec', traits => ['NameInRequest'], request_name => 'spec', required => 1); | ||
| 9 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::AppMesh::TagRef]', traits => ['NameInRequest'], request_name => 'tags'); | ||
| 10 | has VirtualGatewayName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'virtualGatewayName', required => 1); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateGatewayRoute'); | ||
| 15 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v20190125/meshes/{meshName}/virtualGateway/{virtualGatewayName}/gatewayRoutes'); | ||
| 16 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT'); | ||
| 17 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::AppMesh::CreateGatewayRouteOutput'); | ||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::AppMesh::CreateGatewayRoute - Arguments for method CreateGatewayRoute on L<Paws::AppMesh> | ||
| 25 | |||
| 26 | =head1 DESCRIPTION | ||
| 27 | |||
| 28 | This class represents the parameters used for calling the method CreateGatewayRoute on the | ||
| 29 | L<AWS App Mesh|Paws::AppMesh> service. Use the attributes of this class | ||
| 30 | as arguments to method CreateGatewayRoute. | ||
| 31 | |||
| 32 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateGatewayRoute. | ||
| 33 | |||
| 34 | =head1 SYNOPSIS | ||
| 35 | |||
| 36 | my $appmesh = Paws->service('AppMesh'); | ||
| 37 | my $CreateGatewayRouteOutput = $appmesh->CreateGatewayRoute( | ||
| 38 | GatewayRouteName => 'MyResourceName', | ||
| 39 | MeshName => 'MyResourceName', | ||
| 40 | Spec => { | ||
| 41 | GrpcRoute => { | ||
| 42 | Action => { | ||
| 43 | Target => { | ||
| 44 | VirtualService => { | ||
| 45 | VirtualServiceName => 'MyResourceName', # min: 1, max: 255 | ||
| 46 | |||
| 47 | }, | ||
| 48 | |||
| 49 | }, | ||
| 50 | Rewrite => { | ||
| 51 | Hostname => { | ||
| 52 | DefaultTargetHostname => | ||
| 53 | 'ENABLED', # values: ENABLED, DISABLED; OPTIONAL | ||
| 54 | }, # OPTIONAL | ||
| 55 | }, # OPTIONAL | ||
| 56 | }, | ||
| 57 | Match => { | ||
| 58 | Hostname => { | ||
| 59 | Exact => 'MyExactHostName', # min: 1, max: 253; OPTIONAL | ||
| 60 | Suffix => 'MySuffixHostname', # min: 1, max: 253; OPTIONAL | ||
| 61 | }, # OPTIONAL | ||
| 62 | Metadata => [ | ||
| 63 | { | ||
| 64 | Name => 'MyHeaderName', # min: 1, max: 50 | ||
| 65 | Invert => 1, # OPTIONAL | ||
| 66 | Match => { | ||
| 67 | Exact => 'MyHeaderMatch', # min: 1, max: 255; OPTIONAL | ||
| 68 | Prefix => 'MyHeaderMatch', # min: 1, max: 255; OPTIONAL | ||
| 69 | Range => { | ||
| 70 | End => 1, | ||
| 71 | Start => 1, | ||
| 72 | |||
| 73 | }, # OPTIONAL | ||
| 74 | Regex => 'MyHeaderMatch', # min: 1, max: 255; OPTIONAL | ||
| 75 | Suffix => 'MyHeaderMatch', # min: 1, max: 255; OPTIONAL | ||
| 76 | }, # OPTIONAL | ||
| 77 | }, | ||
| 78 | ... | ||
| 79 | ], # min: 1, max: 10; OPTIONAL | ||
| 80 | ServiceName => 'MyServiceName', # OPTIONAL | ||
| 81 | }, | ||
| 82 | |||
| 83 | }, # OPTIONAL | ||
| 84 | Http2Route => { | ||
| 85 | Action => { | ||
| 86 | Target => { | ||
| 87 | VirtualService => { | ||
| 88 | VirtualServiceName => 'MyResourceName', # min: 1, max: 255 | ||
| 89 | |||
| 90 | }, | ||
| 91 | |||
| 92 | }, | ||
| 93 | Rewrite => { | ||
| 94 | Hostname => { | ||
| 95 | DefaultTargetHostname => | ||
| 96 | 'ENABLED', # values: ENABLED, DISABLED; OPTIONAL | ||
| 97 | }, # OPTIONAL | ||
| 98 | Path => { | ||
| 99 | Exact => 'MyHttpPathExact', # min: 1, max: 255; OPTIONAL | ||
| 100 | }, # OPTIONAL | ||
| 101 | Prefix => { | ||
| 102 | DefaultPrefix => | ||
| 103 | 'ENABLED', # values: ENABLED, DISABLED; OPTIONAL | ||
| 104 | Value => | ||
| 105 | 'MyHttpGatewayRoutePrefix', # min: 1, max: 255; OPTIONAL | ||
| 106 | }, # OPTIONAL | ||
| 107 | }, # OPTIONAL | ||
| 108 | }, | ||
| 109 | Match => { | ||
| 110 | Headers => [ | ||
| 111 | { | ||
| 112 | Name => 'MyHeaderName', # min: 1, max: 50 | ||
| 113 | Invert => 1, # OPTIONAL | ||
| 114 | Match => { | ||
| 115 | Exact => 'MyHeaderMatch', # min: 1, max: 255; OPTIONAL | ||
| 116 | Prefix => 'MyHeaderMatch', # min: 1, max: 255; OPTIONAL | ||
| 117 | Range => { | ||
| 118 | End => 1, | ||
| 119 | Start => 1, | ||
| 120 | |||
| 121 | }, # OPTIONAL | ||
| 122 | Regex => 'MyHeaderMatch', # min: 1, max: 255; OPTIONAL | ||
| 123 | Suffix => 'MyHeaderMatch', # min: 1, max: 255; OPTIONAL | ||
| 124 | }, # OPTIONAL | ||
| 125 | }, | ||
| 126 | ... | ||
| 127 | ], # min: 1, max: 10; OPTIONAL | ||
| 128 | Hostname => { | ||
| 129 | Exact => 'MyExactHostName', # min: 1, max: 253; OPTIONAL | ||
| 130 | Suffix => 'MySuffixHostname', # min: 1, max: 253; OPTIONAL | ||
| 131 | }, # OPTIONAL | ||
| 132 | Method => 'GET' | ||
| 133 | , # values: GET, HEAD, POST, PUT, DELETE, CONNECT, OPTIONS, TRACE, PATCH; OPTIONAL | ||
| 134 | Path => { | ||
| 135 | Exact => 'MyHttpPathExact', # min: 1, max: 255; OPTIONAL | ||
| 136 | Regex => 'MyHttpPathRegex', # min: 1, max: 255; OPTIONAL | ||
| 137 | }, # OPTIONAL | ||
| 138 | Prefix => 'MyString', # OPTIONAL | ||
| 139 | QueryParameters => [ | ||
| 140 | { | ||
| 141 | Name => 'MyQueryParameterName', | ||
| 142 | Match => { | ||
| 143 | Exact => 'MyString', # OPTIONAL | ||
| 144 | }, # OPTIONAL | ||
| 145 | }, | ||
| 146 | ... | ||
| 147 | ], # min: 1, max: 10; OPTIONAL | ||
| 148 | }, | ||
| 149 | |||
| 150 | }, # OPTIONAL | ||
| 151 | HttpRoute => { | ||
| 152 | Action => { | ||
| 153 | Target => { | ||
| 154 | VirtualService => { | ||
| 155 | VirtualServiceName => 'MyResourceName', # min: 1, max: 255 | ||
| 156 | |||
| 157 | }, | ||
| 158 | |||
| 159 | }, | ||
| 160 | Rewrite => { | ||
| 161 | Hostname => { | ||
| 162 | DefaultTargetHostname => | ||
| 163 | 'ENABLED', # values: ENABLED, DISABLED; OPTIONAL | ||
| 164 | }, # OPTIONAL | ||
| 165 | Path => { | ||
| 166 | Exact => 'MyHttpPathExact', # min: 1, max: 255; OPTIONAL | ||
| 167 | }, # OPTIONAL | ||
| 168 | Prefix => { | ||
| 169 | DefaultPrefix => | ||
| 170 | 'ENABLED', # values: ENABLED, DISABLED; OPTIONAL | ||
| 171 | Value => | ||
| 172 | 'MyHttpGatewayRoutePrefix', # min: 1, max: 255; OPTIONAL | ||
| 173 | }, # OPTIONAL | ||
| 174 | }, # OPTIONAL | ||
| 175 | }, | ||
| 176 | Match => { | ||
| 177 | Headers => [ | ||
| 178 | { | ||
| 179 | Name => 'MyHeaderName', # min: 1, max: 50 | ||
| 180 | Invert => 1, # OPTIONAL | ||
| 181 | Match => { | ||
| 182 | Exact => 'MyHeaderMatch', # min: 1, max: 255; OPTIONAL | ||
| 183 | Prefix => 'MyHeaderMatch', # min: 1, max: 255; OPTIONAL | ||
| 184 | Range => { | ||
| 185 | End => 1, | ||
| 186 | Start => 1, | ||
| 187 | |||
| 188 | }, # OPTIONAL | ||
| 189 | Regex => 'MyHeaderMatch', # min: 1, max: 255; OPTIONAL | ||
| 190 | Suffix => 'MyHeaderMatch', # min: 1, max: 255; OPTIONAL | ||
| 191 | }, # OPTIONAL | ||
| 192 | }, | ||
| 193 | ... | ||
| 194 | ], # min: 1, max: 10; OPTIONAL | ||
| 195 | Hostname => { | ||
| 196 | Exact => 'MyExactHostName', # min: 1, max: 253; OPTIONAL | ||
| 197 | Suffix => 'MySuffixHostname', # min: 1, max: 253; OPTIONAL | ||
| 198 | }, # OPTIONAL | ||
| 199 | Method => 'GET' | ||
| 200 | , # values: GET, HEAD, POST, PUT, DELETE, CONNECT, OPTIONS, TRACE, PATCH; OPTIONAL | ||
| 201 | Path => { | ||
| 202 | Exact => 'MyHttpPathExact', # min: 1, max: 255; OPTIONAL | ||
| 203 | Regex => 'MyHttpPathRegex', # min: 1, max: 255; OPTIONAL | ||
| 204 | }, # OPTIONAL | ||
| 205 | Prefix => 'MyString', # OPTIONAL | ||
| 206 | QueryParameters => [ | ||
| 207 | { | ||
| 208 | Name => 'MyQueryParameterName', | ||
| 209 | Match => { | ||
| 210 | Exact => 'MyString', # OPTIONAL | ||
| 211 | }, # OPTIONAL | ||
| 212 | }, | ||
| 213 | ... | ||
| 214 | ], # min: 1, max: 10; OPTIONAL | ||
| 215 | }, | ||
| 216 | |||
| 217 | }, # OPTIONAL | ||
| 218 | Priority => 1, # max: 1000; OPTIONAL | ||
| 219 | }, | ||
| 220 | VirtualGatewayName => 'MyResourceName', | ||
| 221 | ClientToken => 'MyString', # OPTIONAL | ||
| 222 | MeshOwner => 'MyAccountId', # OPTIONAL | ||
| 223 | Tags => [ | ||
| 224 | { | ||
| 225 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 226 | Value => 'MyTagValue', # max: 256 | ||
| 227 | |||
| 228 | }, | ||
| 229 | ... | ||
| 230 | ], # OPTIONAL | ||
| 231 | ); | ||
| 232 | |||
| 233 | # Results: | ||
| 234 | my $GatewayRoute = $CreateGatewayRouteOutput->GatewayRoute; | ||
| 235 | |||
| 236 | # Returns a L<Paws::AppMesh::CreateGatewayRouteOutput> object. | ||
| 237 | |||
| 238 | 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. | ||
| 239 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/appmesh/CreateGatewayRoute> | ||
| 240 | |||
| 241 | =head1 ATTRIBUTES | ||
| 242 | |||
| 243 | |||
| 244 | =head2 ClientToken => Str | ||
| 245 | |||
| 246 | Unique, case-sensitive identifier that you provide to ensure the | ||
| 247 | idempotency of the request. Up to 36 letters, numbers, hyphens, and | ||
| 248 | underscores are allowed. | ||
| 249 | |||
| 250 | |||
| 251 | |||
| 252 | =head2 B<REQUIRED> GatewayRouteName => Str | ||
| 253 | |||
| 254 | The name to use for the gateway route. | ||
| 255 | |||
| 256 | |||
| 257 | |||
| 258 | =head2 B<REQUIRED> MeshName => Str | ||
| 259 | |||
| 260 | The name of the service mesh to create the gateway route in. | ||
| 261 | |||
| 262 | |||
| 263 | |||
| 264 | =head2 MeshOwner => Str | ||
| 265 | |||
| 266 | The AWS IAM account ID of the service mesh owner. If the account ID is | ||
| 267 | not your own, then the account that you specify must share the mesh | ||
| 268 | with your account before you can create the resource in the service | ||
| 269 | mesh. For more information about mesh sharing, see Working with shared | ||
| 270 | meshes | ||
| 271 | (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). | ||
| 272 | |||
| 273 | |||
| 274 | |||
| 275 | =head2 B<REQUIRED> Spec => L<Paws::AppMesh::GatewayRouteSpec> | ||
| 276 | |||
| 277 | The gateway route specification to apply. | ||
| 278 | |||
| 279 | |||
| 280 | |||
| 281 | =head2 Tags => ArrayRef[L<Paws::AppMesh::TagRef>] | ||
| 282 | |||
| 283 | Optional metadata that you can apply to the gateway route to assist | ||
| 284 | with categorization and organization. Each tag consists of a key and an | ||
| 285 | optional value, both of which you define. Tag keys can have a maximum | ||
| 286 | character length of 128 characters, and tag values can have a maximum | ||
| 287 | length of 256 characters. | ||
| 288 | |||
| 289 | |||
| 290 | |||
| 291 | =head2 B<REQUIRED> VirtualGatewayName => Str | ||
| 292 | |||
| 293 | The name of the virtual gateway to associate the gateway route with. If | ||
| 294 | the virtual gateway is in a shared mesh, then you must be the owner of | ||
| 295 | the virtual gateway resource. | ||
| 296 | |||
| 297 | |||
| 298 | |||
| 299 | |||
| 300 | =head1 SEE ALSO | ||
| 301 | |||
| 302 | This class forms part of L<Paws>, documenting arguments for method CreateGatewayRoute in L<Paws::AppMesh> | ||
| 303 | |||
| 304 | =head1 BUGS and CONTRIBUTIONS | ||
| 305 | |||
| 306 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 307 | |||
| 308 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 309 | |||
| 310 | =cut | ||
| 311 |