« blib/lib/Paws/EKS/CreateClusterResponse.pm
↑ Summary
blib/lib/Paws/EKS/CreateFargateProfileResponse.pm »
| 1 | |||
| 2 | package Paws::EKS::CreateFargateProfile; | ||
| 3 | use Moose; | ||
| 4 | has ClientRequestToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'clientRequestToken'); | ||
| 5 | has ClusterName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'name', required => 1); | ||
| 6 | has FargateProfileName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'fargateProfileName', required => 1); | ||
| 7 | has PodExecutionRoleArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'podExecutionRoleArn', required => 1); | ||
| 8 | has Selectors => (is => 'ro', isa => 'ArrayRef[Paws::EKS::FargateProfileSelector]', traits => ['NameInRequest'], request_name => 'selectors'); | ||
| 9 | has Subnets => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'subnets'); | ||
| 10 | has Tags => (is => 'ro', isa => 'Paws::EKS::TagMap', traits => ['NameInRequest'], request_name => 'tags'); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateFargateProfile'); | ||
| 15 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/clusters/{name}/fargate-profiles'); | ||
| 16 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 17 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EKS::CreateFargateProfileResponse'); | ||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::EKS::CreateFargateProfile - Arguments for method CreateFargateProfile on L<Paws::EKS> | ||
| 25 | |||
| 26 | =head1 DESCRIPTION | ||
| 27 | |||
| 28 | This class represents the parameters used for calling the method CreateFargateProfile on the | ||
| 29 | L<Amazon Elastic Kubernetes Service|Paws::EKS> service. Use the attributes of this class | ||
| 30 | as arguments to method CreateFargateProfile. | ||
| 31 | |||
| 32 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateFargateProfile. | ||
| 33 | |||
| 34 | =head1 SYNOPSIS | ||
| 35 | |||
| 36 | my $eks = Paws->service('EKS'); | ||
| 37 | my $CreateFargateProfileResponse = $eks->CreateFargateProfile( | ||
| 38 | ClusterName => 'MyString', | ||
| 39 | FargateProfileName => 'MyString', | ||
| 40 | PodExecutionRoleArn => 'MyString', | ||
| 41 | ClientRequestToken => 'MyString', # OPTIONAL | ||
| 42 | Selectors => [ | ||
| 43 | { | ||
| 44 | Labels => { 'MyString' => 'MyString', }, # OPTIONAL | ||
| 45 | Namespace => 'MyString', | ||
| 46 | }, | ||
| 47 | ... | ||
| 48 | ], # OPTIONAL | ||
| 49 | Subnets => [ 'MyString', ... ], # OPTIONAL | ||
| 50 | Tags => { | ||
| 51 | 'MyTagKey' => 'MyTagValue', # key: min: 1, max: 128, value: max: 256 | ||
| 52 | }, # OPTIONAL | ||
| 53 | ); | ||
| 54 | |||
| 55 | # Results: | ||
| 56 | my $FargateProfile = $CreateFargateProfileResponse->FargateProfile; | ||
| 57 | |||
| 58 | # Returns a L<Paws::EKS::CreateFargateProfileResponse> object. | ||
| 59 | |||
| 60 | 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. | ||
| 61 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/eks/CreateFargateProfile> | ||
| 62 | |||
| 63 | =head1 ATTRIBUTES | ||
| 64 | |||
| 65 | |||
| 66 | =head2 ClientRequestToken => Str | ||
| 67 | |||
| 68 | Unique, case-sensitive identifier that you provide to ensure the | ||
| 69 | idempotency of the request. | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head2 B<REQUIRED> ClusterName => Str | ||
| 74 | |||
| 75 | The name of the Amazon EKS cluster to apply the Fargate profile to. | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head2 B<REQUIRED> FargateProfileName => Str | ||
| 80 | |||
| 81 | The name of the Fargate profile. | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | =head2 B<REQUIRED> PodExecutionRoleArn => Str | ||
| 86 | |||
| 87 | The Amazon Resource Name (ARN) of the pod execution role to use for | ||
| 88 | pods that match the selectors in the Fargate profile. The pod execution | ||
| 89 | role allows Fargate infrastructure to register with your cluster as a | ||
| 90 | node, and it provides read access to Amazon ECR image repositories. For | ||
| 91 | more information, see Pod Execution Role | ||
| 92 | (https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html) | ||
| 93 | in the I<Amazon EKS User Guide>. | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | =head2 Selectors => ArrayRef[L<Paws::EKS::FargateProfileSelector>] | ||
| 98 | |||
| 99 | The selectors to match for pods to use this Fargate profile. Each | ||
| 100 | selector must have an associated namespace. Optionally, you can also | ||
| 101 | specify labels for a namespace. You may specify up to five selectors in | ||
| 102 | a Fargate profile. | ||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | =head2 Subnets => ArrayRef[Str|Undef] | ||
| 107 | |||
| 108 | The IDs of subnets to launch your pods into. At this time, pods running | ||
| 109 | on Fargate are not assigned public IP addresses, so only private | ||
| 110 | subnets (with no direct route to an Internet Gateway) are accepted for | ||
| 111 | this parameter. | ||
| 112 | |||
| 113 | |||
| 114 | |||
| 115 | =head2 Tags => L<Paws::EKS::TagMap> | ||
| 116 | |||
| 117 | The metadata to apply to the Fargate profile to assist with | ||
| 118 | categorization and organization. Each tag consists of a key and an | ||
| 119 | optional value, both of which you define. Fargate profile tags do not | ||
| 120 | propagate to any other resources associated with the Fargate profile, | ||
| 121 | such as the pods that are scheduled with it. | ||
| 122 | |||
| 123 | |||
| 124 | |||
| 125 | |||
| 126 | =head1 SEE ALSO | ||
| 127 | |||
| 128 | This class forms part of L<Paws>, documenting arguments for method CreateFargateProfile in L<Paws::EKS> | ||
| 129 | |||
| 130 | =head1 BUGS and CONTRIBUTIONS | ||
| 131 | |||
| 132 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 133 | |||
| 134 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 135 | |||
| 136 | =cut | ||
| 137 |