« blib/lib/Paws/AppMesh/CreateRouteOutput.pm
↑ Summary
blib/lib/Paws/AppMesh/CreateVirtualGatewayOutput.pm »
| 1 | |||
| 2 | package Paws::AppMesh::CreateVirtualGateway; | ||
| 3 | use Moose; | ||
| 4 | has ClientToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'clientToken'); | ||
| 5 | has MeshName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'meshName', required => 1); | ||
| 6 | has MeshOwner => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'meshOwner'); | ||
| 7 | has Spec => (is => 'ro', isa => 'Paws::AppMesh::VirtualGatewaySpec', traits => ['NameInRequest'], request_name => 'spec', required => 1); | ||
| 8 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::AppMesh::TagRef]', traits => ['NameInRequest'], request_name => 'tags'); | ||
| 9 | has VirtualGatewayName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'virtualGatewayName', required => 1); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateVirtualGateway'); | ||
| 14 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v20190125/meshes/{meshName}/virtualGateways'); | ||
| 15 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::AppMesh::CreateVirtualGatewayOutput'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::AppMesh::CreateVirtualGateway - Arguments for method CreateVirtualGateway on L<Paws::AppMesh> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method CreateVirtualGateway on the | ||
| 28 | L<AWS App Mesh|Paws::AppMesh> service. Use the attributes of this class | ||
| 29 | as arguments to method CreateVirtualGateway. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateVirtualGateway. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $appmesh = Paws->service('AppMesh'); | ||
| 36 | my $CreateVirtualGatewayOutput = $appmesh->CreateVirtualGateway( | ||
| 37 | MeshName => 'MyResourceName', | ||
| 38 | Spec => { | ||
| 39 | Listeners => [ | ||
| 40 | { | ||
| 41 | PortMapping => { | ||
| 42 | Port => 1, # min: 1, max: 65535 | ||
| 43 | Protocol => 'http', # values: http, http2, grpc | ||
| 44 | |||
| 45 | }, | ||
| 46 | ConnectionPool => { | ||
| 47 | Grpc => { | ||
| 48 | MaxRequests => 1, # min: 1 | ||
| 49 | |||
| 50 | }, # OPTIONAL | ||
| 51 | Http => { | ||
| 52 | MaxConnections => 1, # min: 1 | ||
| 53 | MaxPendingRequests => 1, # min: 1; OPTIONAL | ||
| 54 | }, # OPTIONAL | ||
| 55 | Http2 => { | ||
| 56 | MaxRequests => 1, # min: 1 | ||
| 57 | |||
| 58 | }, # OPTIONAL | ||
| 59 | }, # OPTIONAL | ||
| 60 | HealthCheck => { | ||
| 61 | HealthyThreshold => 1, # min: 2, max: 10 | ||
| 62 | IntervalMillis => 1, # min: 5000, max: 300000 | ||
| 63 | Protocol => 'http', # values: http, http2, grpc | ||
| 64 | TimeoutMillis => 1, # min: 2000, max: 60000 | ||
| 65 | UnhealthyThreshold => 1, # min: 2, max: 10 | ||
| 66 | Path => 'MyString', # OPTIONAL | ||
| 67 | Port => 1, # min: 1, max: 65535 | ||
| 68 | }, # OPTIONAL | ||
| 69 | Tls => { | ||
| 70 | Certificate => { | ||
| 71 | Acm => { | ||
| 72 | CertificateArn => 'MyArn', | ||
| 73 | |||
| 74 | }, # OPTIONAL | ||
| 75 | File => { | ||
| 76 | CertificateChain => 'MyFilePath', # min: 1, max: 255 | ||
| 77 | PrivateKey => 'MyFilePath', # min: 1, max: 255 | ||
| 78 | |||
| 79 | }, # OPTIONAL | ||
| 80 | Sds => { | ||
| 81 | SecretName => 'MyVirtualGatewaySdsSecretName', | ||
| 82 | |||
| 83 | }, # OPTIONAL | ||
| 84 | }, | ||
| 85 | Mode => 'STRICT', # values: STRICT, PERMISSIVE, DISABLED | ||
| 86 | Validation => { | ||
| 87 | Trust => { | ||
| 88 | File => { | ||
| 89 | CertificateChain => 'MyFilePath', # min: 1, max: 255 | ||
| 90 | |||
| 91 | }, # OPTIONAL | ||
| 92 | Sds => { | ||
| 93 | SecretName => 'MyVirtualGatewaySdsSecretName', | ||
| 94 | |||
| 95 | }, # OPTIONAL | ||
| 96 | }, | ||
| 97 | SubjectAlternativeNames => { | ||
| 98 | Match => { | ||
| 99 | Exact => [ | ||
| 100 | 'MySubjectAlternativeName', ... # min: 1, max: 254 | ||
| 101 | ], | ||
| 102 | |||
| 103 | }, | ||
| 104 | |||
| 105 | }, # OPTIONAL | ||
| 106 | }, # OPTIONAL | ||
| 107 | }, # OPTIONAL | ||
| 108 | }, | ||
| 109 | ... | ||
| 110 | ], # max: 1 | ||
| 111 | BackendDefaults => { | ||
| 112 | ClientPolicy => { | ||
| 113 | Tls => { | ||
| 114 | Validation => { | ||
| 115 | Trust => { | ||
| 116 | Acm => { | ||
| 117 | CertificateAuthorityArns => [ 'MyArn', ... ] | ||
| 118 | , # min: 1, max: 3 | ||
| 119 | |||
| 120 | }, # OPTIONAL | ||
| 121 | File => { | ||
| 122 | CertificateChain => 'MyFilePath', # min: 1, max: 255 | ||
| 123 | |||
| 124 | }, # OPTIONAL | ||
| 125 | Sds => { | ||
| 126 | SecretName => 'MyVirtualGatewaySdsSecretName', | ||
| 127 | |||
| 128 | }, # OPTIONAL | ||
| 129 | }, | ||
| 130 | SubjectAlternativeNames => { | ||
| 131 | Match => { | ||
| 132 | Exact => [ | ||
| 133 | 'MySubjectAlternativeName', ... # min: 1, max: 254 | ||
| 134 | ], | ||
| 135 | |||
| 136 | }, | ||
| 137 | |||
| 138 | }, # OPTIONAL | ||
| 139 | }, | ||
| 140 | Certificate => { | ||
| 141 | File => { | ||
| 142 | CertificateChain => 'MyFilePath', # min: 1, max: 255 | ||
| 143 | PrivateKey => 'MyFilePath', # min: 1, max: 255 | ||
| 144 | |||
| 145 | }, # OPTIONAL | ||
| 146 | Sds => { | ||
| 147 | SecretName => 'MyVirtualGatewaySdsSecretName', | ||
| 148 | |||
| 149 | }, # OPTIONAL | ||
| 150 | }, # OPTIONAL | ||
| 151 | Enforce => 1, # OPTIONAL | ||
| 152 | Ports => [ | ||
| 153 | 1, ... # min: 1, max: 65535 | ||
| 154 | ], # OPTIONAL | ||
| 155 | }, # OPTIONAL | ||
| 156 | }, # OPTIONAL | ||
| 157 | }, # OPTIONAL | ||
| 158 | Logging => { | ||
| 159 | AccessLog => { | ||
| 160 | File => { | ||
| 161 | Path => 'MyFilePath', # min: 1, max: 255 | ||
| 162 | |||
| 163 | }, # OPTIONAL | ||
| 164 | }, # OPTIONAL | ||
| 165 | }, # OPTIONAL | ||
| 166 | }, | ||
| 167 | VirtualGatewayName => 'MyResourceName', | ||
| 168 | ClientToken => 'MyString', # OPTIONAL | ||
| 169 | MeshOwner => 'MyAccountId', # OPTIONAL | ||
| 170 | Tags => [ | ||
| 171 | { | ||
| 172 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 173 | Value => 'MyTagValue', # max: 256 | ||
| 174 | |||
| 175 | }, | ||
| 176 | ... | ||
| 177 | ], # OPTIONAL | ||
| 178 | ); | ||
| 179 | |||
| 180 | # Results: | ||
| 181 | my $VirtualGateway = $CreateVirtualGatewayOutput->VirtualGateway; | ||
| 182 | |||
| 183 | # Returns a L<Paws::AppMesh::CreateVirtualGatewayOutput> object. | ||
| 184 | |||
| 185 | 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. | ||
| 186 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/appmesh/CreateVirtualGateway> | ||
| 187 | |||
| 188 | =head1 ATTRIBUTES | ||
| 189 | |||
| 190 | |||
| 191 | =head2 ClientToken => Str | ||
| 192 | |||
| 193 | Unique, case-sensitive identifier that you provide to ensure the | ||
| 194 | idempotency of the request. Up to 36 letters, numbers, hyphens, and | ||
| 195 | underscores are allowed. | ||
| 196 | |||
| 197 | |||
| 198 | |||
| 199 | =head2 B<REQUIRED> MeshName => Str | ||
| 200 | |||
| 201 | The name of the service mesh to create the virtual gateway in. | ||
| 202 | |||
| 203 | |||
| 204 | |||
| 205 | =head2 MeshOwner => Str | ||
| 206 | |||
| 207 | The AWS IAM account ID of the service mesh owner. If the account ID is | ||
| 208 | not your own, then the account that you specify must share the mesh | ||
| 209 | with your account before you can create the resource in the service | ||
| 210 | mesh. For more information about mesh sharing, see Working with shared | ||
| 211 | meshes | ||
| 212 | (https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html). | ||
| 213 | |||
| 214 | |||
| 215 | |||
| 216 | =head2 B<REQUIRED> Spec => L<Paws::AppMesh::VirtualGatewaySpec> | ||
| 217 | |||
| 218 | The virtual gateway specification to apply. | ||
| 219 | |||
| 220 | |||
| 221 | |||
| 222 | =head2 Tags => ArrayRef[L<Paws::AppMesh::TagRef>] | ||
| 223 | |||
| 224 | Optional metadata that you can apply to the virtual gateway to assist | ||
| 225 | with categorization and organization. Each tag consists of a key and an | ||
| 226 | optional value, both of which you define. Tag keys can have a maximum | ||
| 227 | character length of 128 characters, and tag values can have a maximum | ||
| 228 | length of 256 characters. | ||
| 229 | |||
| 230 | |||
| 231 | |||
| 232 | =head2 B<REQUIRED> VirtualGatewayName => Str | ||
| 233 | |||
| 234 | The name to use for the virtual gateway. | ||
| 235 | |||
| 236 | |||
| 237 | |||
| 238 | |||
| 239 | =head1 SEE ALSO | ||
| 240 | |||
| 241 | This class forms part of L<Paws>, documenting arguments for method CreateVirtualGateway in L<Paws::AppMesh> | ||
| 242 | |||
| 243 | =head1 BUGS and CONTRIBUTIONS | ||
| 244 | |||
| 245 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 246 | |||
| 247 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 248 | |||
| 249 | =cut | ||
| 250 |