« blib/lib/Paws/CloudWatchEvents/CreateArchiveResponse.pm
↑ Summary
blib/lib/Paws/CloudWatchEvents/CreateConnectionApiKeyAuthRequestParameters.pm »
| 1 | |||
| 2 | package Paws::CloudWatchEvents::CreateConnection; | ||
| 3 | use Moose; | ||
| 4 | has AuthorizationType => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has AuthParameters => (is => 'ro', isa => 'Paws::CloudWatchEvents::CreateConnectionAuthRequestParameters', required => 1); | ||
| 6 | has Description => (is => 'ro', isa => 'Str'); | ||
| 7 | has Name => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateConnection'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudWatchEvents::CreateConnectionResponse'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::CloudWatchEvents::CreateConnection - Arguments for method CreateConnection on L<Paws::CloudWatchEvents> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method CreateConnection on the | ||
| 25 | L<Amazon EventBridge|Paws::CloudWatchEvents> service. Use the attributes of this class | ||
| 26 | as arguments to method CreateConnection. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateConnection. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $events = Paws->service('CloudWatchEvents'); | ||
| 33 | my $CreateConnectionResponse = $events->CreateConnection( | ||
| 34 | AuthParameters => { | ||
| 35 | ApiKeyAuthParameters => { | ||
| 36 | ApiKeyName => 'MyAuthHeaderParameters', # min: 1, max: 512 | ||
| 37 | ApiKeyValue => 'MyAuthHeaderParameters', # min: 1, max: 512 | ||
| 38 | |||
| 39 | }, # OPTIONAL | ||
| 40 | BasicAuthParameters => { | ||
| 41 | Password => 'MyAuthHeaderParameters', # min: 1, max: 512 | ||
| 42 | Username => 'MyAuthHeaderParameters', # min: 1, max: 512 | ||
| 43 | |||
| 44 | }, # OPTIONAL | ||
| 45 | InvocationHttpParameters => { | ||
| 46 | BodyParameters => [ | ||
| 47 | { | ||
| 48 | IsValueSecret => 1, # OPTIONAL | ||
| 49 | Key => 'MyString', # OPTIONAL | ||
| 50 | Value => 'MyString', # OPTIONAL | ||
| 51 | }, | ||
| 52 | ... | ||
| 53 | ], # max: 100; OPTIONAL | ||
| 54 | HeaderParameters => [ | ||
| 55 | { | ||
| 56 | IsValueSecret => 1, # OPTIONAL | ||
| 57 | Key => 'MyHeaderKey', # max: 512; OPTIONAL | ||
| 58 | Value => 'MyHeaderValue', # max: 512; OPTIONAL | ||
| 59 | }, | ||
| 60 | ... | ||
| 61 | ], # max: 100; OPTIONAL | ||
| 62 | QueryStringParameters => [ | ||
| 63 | { | ||
| 64 | IsValueSecret => 1, # OPTIONAL | ||
| 65 | Key => 'MyQueryStringKey', # max: 512; OPTIONAL | ||
| 66 | Value => 'MyQueryStringValue', # max: 512; OPTIONAL | ||
| 67 | }, | ||
| 68 | ... | ||
| 69 | ], # max: 100; OPTIONAL | ||
| 70 | }, # OPTIONAL | ||
| 71 | OAuthParameters => { | ||
| 72 | AuthorizationEndpoint => 'MyHttpsEndpoint', # min: 1, max: 2048 | ||
| 73 | ClientParameters => { | ||
| 74 | ClientID => 'MyAuthHeaderParameters', # min: 1, max: 512 | ||
| 75 | ClientSecret => 'MyAuthHeaderParameters', # min: 1, max: 512 | ||
| 76 | |||
| 77 | }, | ||
| 78 | HttpMethod => 'GET', # values: GET, POST, PUT | ||
| 79 | OAuthHttpParameters => { | ||
| 80 | BodyParameters => [ | ||
| 81 | { | ||
| 82 | IsValueSecret => 1, # OPTIONAL | ||
| 83 | Key => 'MyString', # OPTIONAL | ||
| 84 | Value => 'MyString', # OPTIONAL | ||
| 85 | }, | ||
| 86 | ... | ||
| 87 | ], # max: 100; OPTIONAL | ||
| 88 | HeaderParameters => [ | ||
| 89 | { | ||
| 90 | IsValueSecret => 1, # OPTIONAL | ||
| 91 | Key => 'MyHeaderKey', # max: 512; OPTIONAL | ||
| 92 | Value => 'MyHeaderValue', # max: 512; OPTIONAL | ||
| 93 | }, | ||
| 94 | ... | ||
| 95 | ], # max: 100; OPTIONAL | ||
| 96 | QueryStringParameters => [ | ||
| 97 | { | ||
| 98 | IsValueSecret => 1, # OPTIONAL | ||
| 99 | Key => 'MyQueryStringKey', # max: 512; OPTIONAL | ||
| 100 | Value => 'MyQueryStringValue', # max: 512; OPTIONAL | ||
| 101 | }, | ||
| 102 | ... | ||
| 103 | ], # max: 100; OPTIONAL | ||
| 104 | }, # OPTIONAL | ||
| 105 | }, # OPTIONAL | ||
| 106 | }, | ||
| 107 | AuthorizationType => 'BASIC', | ||
| 108 | Name => 'MyConnectionName', | ||
| 109 | Description => 'MyConnectionDescription', # OPTIONAL | ||
| 110 | ); | ||
| 111 | |||
| 112 | # Results: | ||
| 113 | my $ConnectionArn = $CreateConnectionResponse->ConnectionArn; | ||
| 114 | my $ConnectionState = $CreateConnectionResponse->ConnectionState; | ||
| 115 | my $CreationTime = $CreateConnectionResponse->CreationTime; | ||
| 116 | my $LastModifiedTime = $CreateConnectionResponse->LastModifiedTime; | ||
| 117 | |||
| 118 | # Returns a L<Paws::CloudWatchEvents::CreateConnectionResponse> object. | ||
| 119 | |||
| 120 | 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. | ||
| 121 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/events/CreateConnection> | ||
| 122 | |||
| 123 | =head1 ATTRIBUTES | ||
| 124 | |||
| 125 | |||
| 126 | =head2 B<REQUIRED> AuthorizationType => Str | ||
| 127 | |||
| 128 | The type of authorization to use for the connection. | ||
| 129 | |||
| 130 | Valid values are: C<"BASIC">, C<"OAUTH_CLIENT_CREDENTIALS">, C<"API_KEY"> | ||
| 131 | |||
| 132 | =head2 B<REQUIRED> AuthParameters => L<Paws::CloudWatchEvents::CreateConnectionAuthRequestParameters> | ||
| 133 | |||
| 134 | A C<CreateConnectionAuthRequestParameters> object that contains the | ||
| 135 | authorization parameters to use to authorize with the endpoint. | ||
| 136 | |||
| 137 | |||
| 138 | |||
| 139 | =head2 Description => Str | ||
| 140 | |||
| 141 | A description for the connection to create. | ||
| 142 | |||
| 143 | |||
| 144 | |||
| 145 | =head2 B<REQUIRED> Name => Str | ||
| 146 | |||
| 147 | The name for the connection to create. | ||
| 148 | |||
| 149 | |||
| 150 | |||
| 151 | |||
| 152 | =head1 SEE ALSO | ||
| 153 | |||
| 154 | This class forms part of L<Paws>, documenting arguments for method CreateConnection in L<Paws::CloudWatchEvents> | ||
| 155 | |||
| 156 | =head1 BUGS and CONTRIBUTIONS | ||
| 157 | |||
| 158 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 159 | |||
| 160 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 161 | |||
| 162 | =cut | ||
| 163 |