« blib/lib/Paws/ApiGateway/CreateAuthorizer.pm
↑ Summary
blib/lib/Paws/ApiGateway/CreateDeployment.pm »
| 1 | |||
| 2 | package Paws::ApiGateway::CreateBasePathMapping; | ||
| 3 | use Moose; | ||
| 4 | has BasePath => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'basePath'); | ||
| 5 | has DomainName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'domain_name', required => 1); | ||
| 6 | has RestApiId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'restApiId', required => 1); | ||
| 7 | has Stage => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'stage'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateBasePathMapping'); | ||
| 12 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/domainnames/{domain_name}/basepathmappings'); | ||
| 13 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ApiGateway::BasePathMapping'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::ApiGateway::CreateBasePathMapping - Arguments for method CreateBasePathMapping on L<Paws::ApiGateway> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method CreateBasePathMapping on the | ||
| 26 | L<Amazon API Gateway|Paws::ApiGateway> service. Use the attributes of this class | ||
| 27 | as arguments to method CreateBasePathMapping. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateBasePathMapping. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $apigateway = Paws->service('ApiGateway'); | ||
| 34 | my $BasePathMapping = $apigateway->CreateBasePathMapping( | ||
| 35 | DomainName => 'MyString', | ||
| 36 | RestApiId => 'MyString', | ||
| 37 | BasePath => 'MyString', # OPTIONAL | ||
| 38 | Stage => 'MyString', # OPTIONAL | ||
| 39 | ); | ||
| 40 | |||
| 41 | # Results: | ||
| 42 | my $BasePath = $BasePathMapping->BasePath; | ||
| 43 | my $RestApiId = $BasePathMapping->RestApiId; | ||
| 44 | my $Stage = $BasePathMapping->Stage; | ||
| 45 | |||
| 46 | # Returns a L<Paws::ApiGateway::BasePathMapping> object. | ||
| 47 | |||
| 48 | 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. | ||
| 49 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/apigateway/CreateBasePathMapping> | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 BasePath => Str | ||
| 55 | |||
| 56 | The base path name that callers of the API must provide as part of the | ||
| 57 | URL after the domain name. This value must be unique for all of the | ||
| 58 | mappings across a single API. Specify '(none)' if you do not want | ||
| 59 | callers to specify a base path name after the domain name. | ||
| 60 | |||
| 61 | |||
| 62 | |||
| 63 | =head2 B<REQUIRED> DomainName => Str | ||
| 64 | |||
| 65 | [Required] The domain name of the BasePathMapping resource to create. | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head2 B<REQUIRED> RestApiId => Str | ||
| 70 | |||
| 71 | [Required] The string identifier of the associated RestApi. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 Stage => Str | ||
| 76 | |||
| 77 | The name of the API's stage that you want to use for this mapping. | ||
| 78 | Specify '(none)' if you want callers to explicitly specify the stage | ||
| 79 | name after any base path name. | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head1 SEE ALSO | ||
| 85 | |||
| 86 | This class forms part of L<Paws>, documenting arguments for method CreateBasePathMapping in L<Paws::ApiGateway> | ||
| 87 | |||
| 88 | =head1 BUGS and CONTRIBUTIONS | ||
| 89 | |||
| 90 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 91 | |||
| 92 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 93 | |||
| 94 | =cut | ||
| 95 |