« blib/lib/Paws/EKS/CreateFargateProfileResponse.pm
↑ Summary
blib/lib/Paws/EKS/CreateNodegroupResponse.pm »
| 1 | |||
| 2 | package Paws::EKS::CreateNodegroup; | ||
| 3 | use Moose; | ||
| 4 | has AmiType => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'amiType'); | ||
| 5 | has CapacityType => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'capacityType'); | ||
| 6 | has ClientRequestToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'clientRequestToken'); | ||
| 7 | has ClusterName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'name', required => 1); | ||
| 8 | has DiskSize => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'diskSize'); | ||
| 9 | has InstanceTypes => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'instanceTypes'); | ||
| 10 | has Labels => (is => 'ro', isa => 'Paws::EKS::LabelsMap', traits => ['NameInRequest'], request_name => 'labels'); | ||
| 11 | has LaunchTemplate => (is => 'ro', isa => 'Paws::EKS::LaunchTemplateSpecification', traits => ['NameInRequest'], request_name => 'launchTemplate'); | ||
| 12 | has NodegroupName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nodegroupName', required => 1); | ||
| 13 | has NodeRole => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nodeRole', required => 1); | ||
| 14 | has ReleaseVersion => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'releaseVersion'); | ||
| 15 | has RemoteAccess => (is => 'ro', isa => 'Paws::EKS::RemoteAccessConfig', traits => ['NameInRequest'], request_name => 'remoteAccess'); | ||
| 16 | has ScalingConfig => (is => 'ro', isa => 'Paws::EKS::NodegroupScalingConfig', traits => ['NameInRequest'], request_name => 'scalingConfig'); | ||
| 17 | has Subnets => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'subnets', required => 1); | ||
| 18 | has Tags => (is => 'ro', isa => 'Paws::EKS::TagMap', traits => ['NameInRequest'], request_name => 'tags'); | ||
| 19 | has Taints => (is => 'ro', isa => 'ArrayRef[Paws::EKS::Taint]', traits => ['NameInRequest'], request_name => 'taints'); | ||
| 20 | has UpdateConfig => (is => 'ro', isa => 'Paws::EKS::NodegroupUpdateConfig', traits => ['NameInRequest'], request_name => 'updateConfig'); | ||
| 21 | has Version => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'version'); | ||
| 22 | |||
| 23 | use MooseX::ClassAttribute; | ||
| 24 | |||
| 25 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateNodegroup'); | ||
| 26 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/clusters/{name}/node-groups'); | ||
| 27 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 28 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EKS::CreateNodegroupResponse'); | ||
| 29 | 1; | ||
| 30 | |||
| 31 | ### main pod documentation begin ### | ||
| 32 | |||
| 33 | =head1 NAME | ||
| 34 | |||
| 35 | Paws::EKS::CreateNodegroup - Arguments for method CreateNodegroup on L<Paws::EKS> | ||
| 36 | |||
| 37 | =head1 DESCRIPTION | ||
| 38 | |||
| 39 | This class represents the parameters used for calling the method CreateNodegroup on the | ||
| 40 | L<Amazon Elastic Kubernetes Service|Paws::EKS> service. Use the attributes of this class | ||
| 41 | as arguments to method CreateNodegroup. | ||
| 42 | |||
| 43 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateNodegroup. | ||
| 44 | |||
| 45 | =head1 SYNOPSIS | ||
| 46 | |||
| 47 | my $eks = Paws->service('EKS'); | ||
| 48 | my $CreateNodegroupResponse = $eks->CreateNodegroup( | ||
| 49 | ClusterName => 'MyString', | ||
| 50 | NodeRole => 'MyString', | ||
| 51 | NodegroupName => 'MyString', | ||
| 52 | Subnets => [ 'MyString', ... ], | ||
| 53 | AmiType => 'AL2_x86_64', # OPTIONAL | ||
| 54 | CapacityType => 'ON_DEMAND', # OPTIONAL | ||
| 55 | ClientRequestToken => 'MyString', # OPTIONAL | ||
| 56 | DiskSize => 1, # OPTIONAL | ||
| 57 | InstanceTypes => [ 'MyString', ... ], # OPTIONAL | ||
| 58 | Labels => { | ||
| 59 | 'MylabelKey' => | ||
| 60 | 'MylabelValue', # key: min: 1, max: 63, value: min: 1, max: 63 | ||
| 61 | }, # OPTIONAL | ||
| 62 | LaunchTemplate => { | ||
| 63 | Id => 'MyString', | ||
| 64 | Name => 'MyString', | ||
| 65 | Version => 'MyString', | ||
| 66 | }, # OPTIONAL | ||
| 67 | ReleaseVersion => 'MyString', # OPTIONAL | ||
| 68 | RemoteAccess => { | ||
| 69 | Ec2SshKey => 'MyString', | ||
| 70 | SourceSecurityGroups => [ 'MyString', ... ], | ||
| 71 | }, # OPTIONAL | ||
| 72 | ScalingConfig => { | ||
| 73 | DesiredSize => 1, # OPTIONAL | ||
| 74 | MaxSize => 1, # min: 1; OPTIONAL | ||
| 75 | MinSize => 1, # OPTIONAL | ||
| 76 | }, # OPTIONAL | ||
| 77 | Tags => { | ||
| 78 | 'MyTagKey' => 'MyTagValue', # key: min: 1, max: 128, value: max: 256 | ||
| 79 | }, # OPTIONAL | ||
| 80 | Taints => [ | ||
| 81 | { | ||
| 82 | Effect => 'NO_SCHEDULE' | ||
| 83 | , # values: NO_SCHEDULE, NO_EXECUTE, PREFER_NO_SCHEDULE; OPTIONAL | ||
| 84 | Key => 'MytaintKey', # min: 1, max: 63; OPTIONAL | ||
| 85 | Value => 'MytaintValue', # max: 63; OPTIONAL | ||
| 86 | }, | ||
| 87 | ... | ||
| 88 | ], # OPTIONAL | ||
| 89 | UpdateConfig => { | ||
| 90 | MaxUnavailable => 1, # min: 1; OPTIONAL | ||
| 91 | MaxUnavailablePercentage => 1, # min: 1, max: 100; OPTIONAL | ||
| 92 | }, # OPTIONAL | ||
| 93 | Version => 'MyString', # OPTIONAL | ||
| 94 | ); | ||
| 95 | |||
| 96 | # Results: | ||
| 97 | my $Nodegroup = $CreateNodegroupResponse->Nodegroup; | ||
| 98 | |||
| 99 | # Returns a L<Paws::EKS::CreateNodegroupResponse> object. | ||
| 100 | |||
| 101 | 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. | ||
| 102 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/eks/CreateNodegroup> | ||
| 103 | |||
| 104 | =head1 ATTRIBUTES | ||
| 105 | |||
| 106 | |||
| 107 | =head2 AmiType => Str | ||
| 108 | |||
| 109 | The AMI type for your node group. GPU instance types should use the | ||
| 110 | C<AL2_x86_64_GPU> AMI type. Non-GPU instances should use the | ||
| 111 | C<AL2_x86_64> AMI type. Arm instances should use the C<AL2_ARM_64> AMI | ||
| 112 | type. All types use the Amazon EKS optimized Amazon Linux 2 AMI. If you | ||
| 113 | specify C<launchTemplate>, and your launch template uses a custom AMI, | ||
| 114 | then don't specify C<amiType>, or the node group deployment will fail. | ||
| 115 | For more information about using launch templates with Amazon EKS, see | ||
| 116 | Launch template support | ||
| 117 | (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) | ||
| 118 | in the Amazon EKS User Guide. | ||
| 119 | |||
| 120 | Valid values are: C<"AL2_x86_64">, C<"AL2_x86_64_GPU">, C<"AL2_ARM_64">, C<"CUSTOM"> | ||
| 121 | |||
| 122 | =head2 CapacityType => Str | ||
| 123 | |||
| 124 | The capacity type for your node group. | ||
| 125 | |||
| 126 | Valid values are: C<"ON_DEMAND">, C<"SPOT"> | ||
| 127 | |||
| 128 | =head2 ClientRequestToken => Str | ||
| 129 | |||
| 130 | Unique, case-sensitive identifier that you provide to ensure the | ||
| 131 | idempotency of the request. | ||
| 132 | |||
| 133 | |||
| 134 | |||
| 135 | =head2 B<REQUIRED> ClusterName => Str | ||
| 136 | |||
| 137 | The name of the cluster to create the node group in. | ||
| 138 | |||
| 139 | |||
| 140 | |||
| 141 | =head2 DiskSize => Int | ||
| 142 | |||
| 143 | The root device disk size (in GiB) for your node group instances. The | ||
| 144 | default disk size is 20 GiB. If you specify C<launchTemplate>, then | ||
| 145 | don't specify C<diskSize>, or the node group deployment will fail. For | ||
| 146 | more information about using launch templates with Amazon EKS, see | ||
| 147 | Launch template support | ||
| 148 | (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) | ||
| 149 | in the Amazon EKS User Guide. | ||
| 150 | |||
| 151 | |||
| 152 | |||
| 153 | =head2 InstanceTypes => ArrayRef[Str|Undef] | ||
| 154 | |||
| 155 | Specify the instance types for a node group. If you specify a GPU | ||
| 156 | instance type, be sure to specify C<AL2_x86_64_GPU> with the C<amiType> | ||
| 157 | parameter. If you specify C<launchTemplate>, then you can specify zero | ||
| 158 | or one instance type in your launch template I<or> you can specify 0-20 | ||
| 159 | instance types for C<instanceTypes>. If however, you specify an | ||
| 160 | instance type in your launch template I<and> specify any | ||
| 161 | C<instanceTypes>, the node group deployment will fail. If you don't | ||
| 162 | specify an instance type in a launch template or for C<instanceTypes>, | ||
| 163 | then C<t3.medium> is used, by default. If you specify C<Spot> for | ||
| 164 | C<capacityType>, then we recommend specifying multiple values for | ||
| 165 | C<instanceTypes>. For more information, see Managed node group capacity | ||
| 166 | types | ||
| 167 | (https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html#managed-node-group-capacity-types) | ||
| 168 | and Launch template support | ||
| 169 | (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) | ||
| 170 | in the I<Amazon EKS User Guide>. | ||
| 171 | |||
| 172 | |||
| 173 | |||
| 174 | =head2 Labels => L<Paws::EKS::LabelsMap> | ||
| 175 | |||
| 176 | The Kubernetes labels to be applied to the nodes in the node group when | ||
| 177 | they are created. | ||
| 178 | |||
| 179 | |||
| 180 | |||
| 181 | =head2 LaunchTemplate => L<Paws::EKS::LaunchTemplateSpecification> | ||
| 182 | |||
| 183 | An object representing a node group's launch template specification. If | ||
| 184 | specified, then do not specify C<instanceTypes>, C<diskSize>, or | ||
| 185 | C<remoteAccess> and make sure that the launch template meets the | ||
| 186 | requirements in C<launchTemplateSpecification>. | ||
| 187 | |||
| 188 | |||
| 189 | |||
| 190 | =head2 B<REQUIRED> NodegroupName => Str | ||
| 191 | |||
| 192 | The unique name to give your node group. | ||
| 193 | |||
| 194 | |||
| 195 | |||
| 196 | =head2 B<REQUIRED> NodeRole => Str | ||
| 197 | |||
| 198 | The Amazon Resource Name (ARN) of the IAM role to associate with your | ||
| 199 | node group. The Amazon EKS worker node C<kubelet> daemon makes calls to | ||
| 200 | AWS APIs on your behalf. Nodes receive permissions for these API calls | ||
| 201 | through an IAM instance profile and associated policies. Before you can | ||
| 202 | launch nodes and register them into a cluster, you must create an IAM | ||
| 203 | role for those nodes to use when they are launched. For more | ||
| 204 | information, see Amazon EKS node IAM role | ||
| 205 | (https://docs.aws.amazon.com/eks/latest/userguide/worker_node_IAM_role.html) | ||
| 206 | in the I< I<Amazon EKS User Guide> >. If you specify C<launchTemplate>, | ||
| 207 | then don't specify C<IamInstanceProfile> | ||
| 208 | (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_IamInstanceProfile.html) | ||
| 209 | in your launch template, or the node group deployment will fail. For | ||
| 210 | more information about using launch templates with Amazon EKS, see | ||
| 211 | Launch template support | ||
| 212 | (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) | ||
| 213 | in the Amazon EKS User Guide. | ||
| 214 | |||
| 215 | |||
| 216 | |||
| 217 | =head2 ReleaseVersion => Str | ||
| 218 | |||
| 219 | The AMI version of the Amazon EKS optimized AMI to use with your node | ||
| 220 | group. By default, the latest available AMI version for the node | ||
| 221 | group's current Kubernetes version is used. For more information, see | ||
| 222 | Amazon EKS optimized Amazon Linux 2 AMI versions | ||
| 223 | (https://docs.aws.amazon.com/eks/latest/userguide/eks-linux-ami-versions.html) | ||
| 224 | in the I<Amazon EKS User Guide>. If you specify C<launchTemplate>, and | ||
| 225 | your launch template uses a custom AMI, then don't specify | ||
| 226 | C<releaseVersion>, or the node group deployment will fail. For more | ||
| 227 | information about using launch templates with Amazon EKS, see Launch | ||
| 228 | template support | ||
| 229 | (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) | ||
| 230 | in the Amazon EKS User Guide. | ||
| 231 | |||
| 232 | |||
| 233 | |||
| 234 | =head2 RemoteAccess => L<Paws::EKS::RemoteAccessConfig> | ||
| 235 | |||
| 236 | The remote access (SSH) configuration to use with your node group. If | ||
| 237 | you specify C<launchTemplate>, then don't specify C<remoteAccess>, or | ||
| 238 | the node group deployment will fail. For more information about using | ||
| 239 | launch templates with Amazon EKS, see Launch template support | ||
| 240 | (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) | ||
| 241 | in the Amazon EKS User Guide. | ||
| 242 | |||
| 243 | |||
| 244 | |||
| 245 | =head2 ScalingConfig => L<Paws::EKS::NodegroupScalingConfig> | ||
| 246 | |||
| 247 | The scaling configuration details for the Auto Scaling group that is | ||
| 248 | created for your node group. | ||
| 249 | |||
| 250 | |||
| 251 | |||
| 252 | =head2 B<REQUIRED> Subnets => ArrayRef[Str|Undef] | ||
| 253 | |||
| 254 | The subnets to use for the Auto Scaling group that is created for your | ||
| 255 | node group. If you specify C<launchTemplate>, then don't specify | ||
| 256 | C<SubnetId> | ||
| 257 | (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateNetworkInterface.html) | ||
| 258 | in your launch template, or the node group deployment will fail. For | ||
| 259 | more information about using launch templates with Amazon EKS, see | ||
| 260 | Launch template support | ||
| 261 | (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) | ||
| 262 | in the Amazon EKS User Guide. | ||
| 263 | |||
| 264 | |||
| 265 | |||
| 266 | =head2 Tags => L<Paws::EKS::TagMap> | ||
| 267 | |||
| 268 | The metadata to apply to the node group to assist with categorization | ||
| 269 | and organization. Each tag consists of a key and an optional value, | ||
| 270 | both of which you define. Node group tags do not propagate to any other | ||
| 271 | resources associated with the node group, such as the Amazon EC2 | ||
| 272 | instances or subnets. | ||
| 273 | |||
| 274 | |||
| 275 | |||
| 276 | =head2 Taints => ArrayRef[L<Paws::EKS::Taint>] | ||
| 277 | |||
| 278 | The Kubernetes taints to be applied to the nodes in the node group. | ||
| 279 | |||
| 280 | |||
| 281 | |||
| 282 | =head2 UpdateConfig => L<Paws::EKS::NodegroupUpdateConfig> | ||
| 283 | |||
| 284 | |||
| 285 | |||
| 286 | |||
| 287 | |||
| 288 | =head2 Version => Str | ||
| 289 | |||
| 290 | The Kubernetes version to use for your managed nodes. By default, the | ||
| 291 | Kubernetes version of the cluster is used, and this is the only | ||
| 292 | accepted specified value. If you specify C<launchTemplate>, and your | ||
| 293 | launch template uses a custom AMI, then don't specify C<version>, or | ||
| 294 | the node group deployment will fail. For more information about using | ||
| 295 | launch templates with Amazon EKS, see Launch template support | ||
| 296 | (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) | ||
| 297 | in the Amazon EKS User Guide. | ||
| 298 | |||
| 299 | |||
| 300 | |||
| 301 | |||
| 302 | =head1 SEE ALSO | ||
| 303 | |||
| 304 | This class forms part of L<Paws>, documenting arguments for method CreateNodegroup in L<Paws::EKS> | ||
| 305 | |||
| 306 | =head1 BUGS and CONTRIBUTIONS | ||
| 307 | |||
| 308 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 309 | |||
| 310 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 311 | |||
| 312 | =cut | ||
| 313 |