« blib/lib/Paws/CloudWatchEvents/ConnectionQueryStringParameter.pm
↑ Summary
blib/lib/Paws/CloudWatchEvents/CreateApiDestinationResponse.pm »
| 1 | |||
| 2 | package Paws::CloudWatchEvents::CreateApiDestination; | ||
| 3 | use Moose; | ||
| 4 | has ConnectionArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has Description => (is => 'ro', isa => 'Str'); | ||
| 6 | has HttpMethod => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has InvocationEndpoint => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has InvocationRateLimitPerSecond => (is => 'ro', isa => 'Int'); | ||
| 9 | has Name => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateApiDestination'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudWatchEvents::CreateApiDestinationResponse'); | ||
| 15 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::CloudWatchEvents::CreateApiDestination - Arguments for method CreateApiDestination on L<Paws::CloudWatchEvents> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method CreateApiDestination on the | ||
| 27 | L<Amazon EventBridge|Paws::CloudWatchEvents> service. Use the attributes of this class | ||
| 28 | as arguments to method CreateApiDestination. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateApiDestination. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $events = Paws->service('CloudWatchEvents'); | ||
| 35 | my $CreateApiDestinationResponse = $events->CreateApiDestination( | ||
| 36 | ConnectionArn => 'MyConnectionArn', | ||
| 37 | HttpMethod => 'POST', | ||
| 38 | InvocationEndpoint => 'MyHttpsEndpoint', | ||
| 39 | Name => 'MyApiDestinationName', | ||
| 40 | Description => 'MyApiDestinationDescription', # OPTIONAL | ||
| 41 | InvocationRateLimitPerSecond => 1, # OPTIONAL | ||
| 42 | ); | ||
| 43 | |||
| 44 | # Results: | ||
| 45 | my $ApiDestinationArn = $CreateApiDestinationResponse->ApiDestinationArn; | ||
| 46 | my $ApiDestinationState = | ||
| 47 | $CreateApiDestinationResponse->ApiDestinationState; | ||
| 48 | my $CreationTime = $CreateApiDestinationResponse->CreationTime; | ||
| 49 | my $LastModifiedTime = $CreateApiDestinationResponse->LastModifiedTime; | ||
| 50 | |||
| 51 | # Returns a L<Paws::CloudWatchEvents::CreateApiDestinationResponse> object. | ||
| 52 | |||
| 53 | 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. | ||
| 54 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/events/CreateApiDestination> | ||
| 55 | |||
| 56 | =head1 ATTRIBUTES | ||
| 57 | |||
| 58 | |||
| 59 | =head2 B<REQUIRED> ConnectionArn => Str | ||
| 60 | |||
| 61 | The ARN of the connection to use for the API destination. The | ||
| 62 | destination endpoint must support the authorization type specified for | ||
| 63 | the connection. | ||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | =head2 Description => Str | ||
| 68 | |||
| 69 | A description for the API destination to create. | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head2 B<REQUIRED> HttpMethod => Str | ||
| 74 | |||
| 75 | The method to use for the request to the HTTP invocation endpoint. | ||
| 76 | |||
| 77 | Valid values are: C<"POST">, C<"GET">, C<"HEAD">, C<"OPTIONS">, C<"PUT">, C<"PATCH">, C<"DELETE"> | ||
| 78 | |||
| 79 | =head2 B<REQUIRED> InvocationEndpoint => Str | ||
| 80 | |||
| 81 | The URL to the HTTP invocation endpoint for the API destination. | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | =head2 InvocationRateLimitPerSecond => Int | ||
| 86 | |||
| 87 | The maximum number of requests per second to send to the HTTP | ||
| 88 | invocation endpoint. | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head2 B<REQUIRED> Name => Str | ||
| 93 | |||
| 94 | The name for the API destination to create. | ||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head1 SEE ALSO | ||
| 100 | |||
| 101 | This class forms part of L<Paws>, documenting arguments for method CreateApiDestination in L<Paws::CloudWatchEvents> | ||
| 102 | |||
| 103 | =head1 BUGS and CONTRIBUTIONS | ||
| 104 | |||
| 105 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 106 | |||
| 107 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 108 | |||
| 109 | =cut | ||
| 110 |