« blib/lib/Paws/ECS/CreateCapacityProviderResponse.pm
↑ Summary
blib/lib/Paws/ECS/CreateClusterResponse.pm »
| 1 | |||
| 2 | package Paws::ECS::CreateCluster; | ||
| 3 | use Moose; | ||
| 4 | has CapacityProviders => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'capacityProviders' ); | ||
| 5 | has ClusterName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'clusterName' ); | ||
| 6 | has Configuration => (is => 'ro', isa => 'Paws::ECS::ClusterConfiguration', traits => ['NameInRequest'], request_name => 'configuration' ); | ||
| 7 | has DefaultCapacityProviderStrategy => (is => 'ro', isa => 'ArrayRef[Paws::ECS::CapacityProviderStrategyItem]', traits => ['NameInRequest'], request_name => 'defaultCapacityProviderStrategy' ); | ||
| 8 | has Settings => (is => 'ro', isa => 'ArrayRef[Paws::ECS::ClusterSetting]', traits => ['NameInRequest'], request_name => 'settings' ); | ||
| 9 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::ECS::Tag]', traits => ['NameInRequest'], request_name => 'tags' ); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateCluster'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ECS::CreateClusterResponse'); | ||
| 15 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::ECS::CreateCluster - Arguments for method CreateCluster on L<Paws::ECS> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method CreateCluster on the | ||
| 27 | L<Amazon EC2 Container Service|Paws::ECS> service. Use the attributes of this class | ||
| 28 | as arguments to method CreateCluster. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateCluster. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $ecs = Paws->service('ECS'); | ||
| 35 | # To create a new cluster | ||
| 36 | # This example creates a cluster in your default region. | ||
| 37 | my $CreateClusterResponse = | ||
| 38 | $ecs->CreateCluster( 'ClusterName' => 'my_cluster' ); | ||
| 39 | |||
| 40 | # Results: | ||
| 41 | my $cluster = $CreateClusterResponse->cluster; | ||
| 42 | |||
| 43 | # Returns a L<Paws::ECS::CreateClusterResponse> object. | ||
| 44 | |||
| 45 | 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. | ||
| 46 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ecs/CreateCluster> | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 CapacityProviders => ArrayRef[Str|Undef] | ||
| 52 | |||
| 53 | The short name of one or more capacity providers to associate with the | ||
| 54 | cluster. A capacity provider must be associated with a cluster before | ||
| 55 | it can be included as part of the default capacity provider strategy of | ||
| 56 | the cluster or used in a capacity provider strategy when calling the | ||
| 57 | CreateService or RunTask actions. | ||
| 58 | |||
| 59 | If specifying a capacity provider that uses an Auto Scaling group, the | ||
| 60 | capacity provider must already be created and not already associated | ||
| 61 | with another cluster. New Auto Scaling group capacity providers can be | ||
| 62 | created with the CreateCapacityProvider API operation. | ||
| 63 | |||
| 64 | To use a AWS Fargate capacity provider, specify either the C<FARGATE> | ||
| 65 | or C<FARGATE_SPOT> capacity providers. The AWS Fargate capacity | ||
| 66 | providers are available to all accounts and only need to be associated | ||
| 67 | with a cluster to be used. | ||
| 68 | |||
| 69 | The PutClusterCapacityProviders API operation is used to update the | ||
| 70 | list of available capacity providers for a cluster after the cluster is | ||
| 71 | created. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 ClusterName => Str | ||
| 76 | |||
| 77 | The name of your cluster. If you do not specify a name for your | ||
| 78 | cluster, you create a cluster named C<default>. Up to 255 letters | ||
| 79 | (uppercase and lowercase), numbers, underscores, and hyphens are | ||
| 80 | allowed. | ||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head2 Configuration => L<Paws::ECS::ClusterConfiguration> | ||
| 85 | |||
| 86 | The execute command configuration for the cluster. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head2 DefaultCapacityProviderStrategy => ArrayRef[L<Paws::ECS::CapacityProviderStrategyItem>] | ||
| 91 | |||
| 92 | The capacity provider strategy to set as the default for the cluster. | ||
| 93 | When a default capacity provider strategy is set for a cluster, when | ||
| 94 | calling the RunTask or CreateService APIs wtih no capacity provider | ||
| 95 | strategy or launch type specified, the default capacity provider | ||
| 96 | strategy for the cluster is used. | ||
| 97 | |||
| 98 | If a default capacity provider strategy is not defined for a cluster | ||
| 99 | during creation, it can be defined later with the | ||
| 100 | PutClusterCapacityProviders API operation. | ||
| 101 | |||
| 102 | |||
| 103 | |||
| 104 | =head2 Settings => ArrayRef[L<Paws::ECS::ClusterSetting>] | ||
| 105 | |||
| 106 | The setting to use when creating a cluster. This parameter is used to | ||
| 107 | enable CloudWatch Container Insights for a cluster. If this value is | ||
| 108 | specified, it will override the C<containerInsights> value set with | ||
| 109 | PutAccountSetting or PutAccountSettingDefault. | ||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | =head2 Tags => ArrayRef[L<Paws::ECS::Tag>] | ||
| 114 | |||
| 115 | The metadata that you apply to the cluster to help you categorize and | ||
| 116 | organize them. Each tag consists of a key and an optional value, both | ||
| 117 | of which you define. | ||
| 118 | |||
| 119 | The following basic restrictions apply to tags: | ||
| 120 | |||
| 121 | =over | ||
| 122 | |||
| 123 | =item * | ||
| 124 | |||
| 125 | Maximum number of tags per resource - 50 | ||
| 126 | |||
| 127 | =item * | ||
| 128 | |||
| 129 | For each resource, each tag key must be unique, and each tag key can | ||
| 130 | have only one value. | ||
| 131 | |||
| 132 | =item * | ||
| 133 | |||
| 134 | Maximum key length - 128 Unicode characters in UTF-8 | ||
| 135 | |||
| 136 | =item * | ||
| 137 | |||
| 138 | Maximum value length - 256 Unicode characters in UTF-8 | ||
| 139 | |||
| 140 | =item * | ||
| 141 | |||
| 142 | If your tagging schema is used across multiple services and resources, | ||
| 143 | remember that other services may have restrictions on allowed | ||
| 144 | characters. Generally allowed characters are: letters, numbers, and | ||
| 145 | spaces representable in UTF-8, and the following characters: + - = . _ | ||
| 146 | : / @. | ||
| 147 | |||
| 148 | =item * | ||
| 149 | |||
| 150 | Tag keys and values are case-sensitive. | ||
| 151 | |||
| 152 | =item * | ||
| 153 | |||
| 154 | Do not use C<aws:>, C<AWS:>, or any upper or lowercase combination of | ||
| 155 | such as a prefix for either keys or values as it is reserved for AWS | ||
| 156 | use. You cannot edit or delete tag keys or values with this prefix. | ||
| 157 | Tags with this prefix do not count against your tags per resource | ||
| 158 | limit. | ||
| 159 | |||
| 160 | =back | ||
| 161 | |||
| 162 | |||
| 163 | |||
| 164 | |||
| 165 | |||
| 166 | =head1 SEE ALSO | ||
| 167 | |||
| 168 | This class forms part of L<Paws>, documenting arguments for method CreateCluster in L<Paws::ECS> | ||
| 169 | |||
| 170 | =head1 BUGS and CONTRIBUTIONS | ||
| 171 | |||
| 172 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 173 | |||
| 174 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 175 | |||
| 176 | =cut | ||
| 177 |