« blib/lib/Paws/AppMesh/DescribeMeshOutput.pm
↑ Summary
blib/lib/Paws/AppMesh/DescribeRouteOutput.pm »
| 1 | |||
| 2 | package Paws::AppMesh::DescribeRoute; | ||
| 3 | use Moose; | ||
| 4 | has MeshName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'meshName', required => 1); | ||
| 5 | has MeshOwner => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'meshOwner'); | ||
| 6 | has RouteName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'routeName', required => 1); | ||
| 7 | has VirtualRouterName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'virtualRouterName', required => 1); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeRoute'); | ||
| 12 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v20190125/meshes/{meshName}/virtualRouter/{virtualRouterName}/routes/{routeName}'); | ||
| 13 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::AppMesh::DescribeRouteOutput'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::AppMesh::DescribeRoute - Arguments for method DescribeRoute on L<Paws::AppMesh> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method DescribeRoute on the | ||
| 26 | L<AWS App Mesh|Paws::AppMesh> service. Use the attributes of this class | ||
| 27 | as arguments to method DescribeRoute. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeRoute. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $appmesh = Paws->service('AppMesh'); | ||
| 34 | my $DescribeRouteOutput = $appmesh->DescribeRoute( | ||
| 35 | MeshName => 'MyResourceName', | ||
| 36 | RouteName => 'MyResourceName', | ||
| 37 | VirtualRouterName => 'MyResourceName', | ||
| 38 | MeshOwner => 'MyAccountId', # OPTIONAL | ||
| 39 | ); | ||
| 40 | |||
| 41 | # Results: | ||
| 42 | my $Route = $DescribeRouteOutput->Route; | ||
| 43 | |||
| 44 | # Returns a L<Paws::AppMesh::DescribeRouteOutput> object. | ||
| 45 | |||
| 46 | 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. | ||
| 47 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/appmesh/DescribeRoute> | ||
| 48 | |||
| 49 | =head1 ATTRIBUTES | ||
| 50 | |||
| 51 | |||
| 52 | =head2 B<REQUIRED> MeshName => Str | ||
| 53 | |||
| 54 | The name of the service mesh that the route resides in. | ||
| 55 | |||
| 56 | |||
| 57 | |||
| 58 | =head2 MeshOwner => Str | ||
| 59 | |||
| 60 | The AWS IAM account ID of the service mesh owner. If the account ID is | ||
| 61 | not your own, then it's the ID of the account that shared the mesh with | ||
| 62 | your account. For more information about mesh sharing, see Working with | ||
| 63 | shared meshes | ||
| 64 | (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head2 B<REQUIRED> RouteName => Str | ||
| 69 | |||
| 70 | The name of the route to describe. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head2 B<REQUIRED> VirtualRouterName => Str | ||
| 75 | |||
| 76 | The name of the virtual router that the route is associated with. | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head1 SEE ALSO | ||
| 82 | |||
| 83 | This class forms part of L<Paws>, documenting arguments for method DescribeRoute in L<Paws::AppMesh> | ||
| 84 | |||
| 85 | =head1 BUGS and CONTRIBUTIONS | ||
| 86 | |||
| 87 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 88 | |||
| 89 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 90 | |||
| 91 | =cut | ||
| 92 |