« blib/lib/Paws/ECS/PutClusterCapacityProvidersResponse.pm
↑ Summary
blib/lib/Paws/ECS/RegisterContainerInstanceResponse.pm »
| 1 | |||
| 2 | package Paws::ECS::RegisterContainerInstance; | ||
| 3 | use Moose; | ||
| 4 | has Attributes => (is => 'ro', isa => 'ArrayRef[Paws::ECS::Attribute]', traits => ['NameInRequest'], request_name => 'attributes' ); | ||
| 5 | has Cluster => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'cluster' ); | ||
| 6 | has ContainerInstanceArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'containerInstanceArn' ); | ||
| 7 | has InstanceIdentityDocument => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'instanceIdentityDocument' ); | ||
| 8 | has InstanceIdentityDocumentSignature => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'instanceIdentityDocumentSignature' ); | ||
| 9 | has PlatformDevices => (is => 'ro', isa => 'ArrayRef[Paws::ECS::PlatformDevice]', traits => ['NameInRequest'], request_name => 'platformDevices' ); | ||
| 10 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::ECS::Tag]', traits => ['NameInRequest'], request_name => 'tags' ); | ||
| 11 | has TotalResources => (is => 'ro', isa => 'ArrayRef[Paws::ECS::Resource]', traits => ['NameInRequest'], request_name => 'totalResources' ); | ||
| 12 | has VersionInfo => (is => 'ro', isa => 'Paws::ECS::VersionInfo', traits => ['NameInRequest'], request_name => 'versionInfo' ); | ||
| 13 | |||
| 14 | use MooseX::ClassAttribute; | ||
| 15 | |||
| 16 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'RegisterContainerInstance'); | ||
| 17 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ECS::RegisterContainerInstanceResponse'); | ||
| 18 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::ECS::RegisterContainerInstance - Arguments for method RegisterContainerInstance on L<Paws::ECS> | ||
| 26 | |||
| 27 | =head1 DESCRIPTION | ||
| 28 | |||
| 29 | This class represents the parameters used for calling the method RegisterContainerInstance on the | ||
| 30 | L<Amazon EC2 Container Service|Paws::ECS> service. Use the attributes of this class | ||
| 31 | as arguments to method RegisterContainerInstance. | ||
| 32 | |||
| 33 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RegisterContainerInstance. | ||
| 34 | |||
| 35 | =head1 SYNOPSIS | ||
| 36 | |||
| 37 | my $ecs = Paws->service('ECS'); | ||
| 38 | my $RegisterContainerInstanceResponse = $ecs->RegisterContainerInstance( | ||
| 39 | Attributes => [ | ||
| 40 | { | ||
| 41 | Name => 'MyString', | ||
| 42 | TargetId => 'MyString', | ||
| 43 | TargetType => | ||
| 44 | 'container-instance', # values: container-instance; OPTIONAL | ||
| 45 | Value => 'MyString', | ||
| 46 | }, | ||
| 47 | ... | ||
| 48 | ], # OPTIONAL | ||
| 49 | Cluster => 'MyString', # OPTIONAL | ||
| 50 | ContainerInstanceArn => 'MyString', # OPTIONAL | ||
| 51 | InstanceIdentityDocument => 'MyString', # OPTIONAL | ||
| 52 | InstanceIdentityDocumentSignature => 'MyString', # OPTIONAL | ||
| 53 | PlatformDevices => [ | ||
| 54 | { | ||
| 55 | Id => 'MyString', | ||
| 56 | Type => 'GPU', # values: GPU | ||
| 57 | |||
| 58 | }, | ||
| 59 | ... | ||
| 60 | ], # OPTIONAL | ||
| 61 | Tags => [ | ||
| 62 | { | ||
| 63 | Key => 'MyTagKey', # min: 1, max: 128; OPTIONAL | ||
| 64 | Value => 'MyTagValue', # max: 256; OPTIONAL | ||
| 65 | }, | ||
| 66 | ... | ||
| 67 | ], # OPTIONAL | ||
| 68 | TotalResources => [ | ||
| 69 | { | ||
| 70 | DoubleValue => 1, # OPTIONAL | ||
| 71 | IntegerValue => 1, # OPTIONAL | ||
| 72 | LongValue => 1, # OPTIONAL | ||
| 73 | Name => 'MyString', | ||
| 74 | StringSetValue => [ 'MyString', ... ], # OPTIONAL | ||
| 75 | Type => 'MyString', | ||
| 76 | }, | ||
| 77 | ... | ||
| 78 | ], # OPTIONAL | ||
| 79 | VersionInfo => { | ||
| 80 | AgentHash => 'MyString', | ||
| 81 | AgentVersion => 'MyString', | ||
| 82 | DockerVersion => 'MyString', | ||
| 83 | }, # OPTIONAL | ||
| 84 | ); | ||
| 85 | |||
| 86 | # Results: | ||
| 87 | my $ContainerInstance = | ||
| 88 | $RegisterContainerInstanceResponse->ContainerInstance; | ||
| 89 | |||
| 90 | # Returns a L<Paws::ECS::RegisterContainerInstanceResponse> object. | ||
| 91 | |||
| 92 | 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. | ||
| 93 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ecs/RegisterContainerInstance> | ||
| 94 | |||
| 95 | =head1 ATTRIBUTES | ||
| 96 | |||
| 97 | |||
| 98 | =head2 Attributes => ArrayRef[L<Paws::ECS::Attribute>] | ||
| 99 | |||
| 100 | The container instance attributes that this container instance | ||
| 101 | supports. | ||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head2 Cluster => Str | ||
| 106 | |||
| 107 | The short name or full Amazon Resource Name (ARN) of the cluster with | ||
| 108 | which to register your container instance. If you do not specify a | ||
| 109 | cluster, the default cluster is assumed. | ||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | =head2 ContainerInstanceArn => Str | ||
| 114 | |||
| 115 | The ARN of the container instance (if it was previously registered). | ||
| 116 | |||
| 117 | |||
| 118 | |||
| 119 | =head2 InstanceIdentityDocument => Str | ||
| 120 | |||
| 121 | The instance identity document for the EC2 instance to register. This | ||
| 122 | document can be found by running the following command from the | ||
| 123 | instance: C<curl | ||
| 124 | http://169.254.169.254/latest/dynamic/instance-identity/document/> | ||
| 125 | |||
| 126 | |||
| 127 | |||
| 128 | =head2 InstanceIdentityDocumentSignature => Str | ||
| 129 | |||
| 130 | The instance identity document signature for the EC2 instance to | ||
| 131 | register. This signature can be found by running the following command | ||
| 132 | from the instance: C<curl | ||
| 133 | http://169.254.169.254/latest/dynamic/instance-identity/signature/> | ||
| 134 | |||
| 135 | |||
| 136 | |||
| 137 | =head2 PlatformDevices => ArrayRef[L<Paws::ECS::PlatformDevice>] | ||
| 138 | |||
| 139 | The devices that are available on the container instance. The only | ||
| 140 | supported device type is a GPU. | ||
| 141 | |||
| 142 | |||
| 143 | |||
| 144 | =head2 Tags => ArrayRef[L<Paws::ECS::Tag>] | ||
| 145 | |||
| 146 | The metadata that you apply to the container instance to help you | ||
| 147 | categorize and organize them. Each tag consists of a key and an | ||
| 148 | optional value, both of which you define. | ||
| 149 | |||
| 150 | The following basic restrictions apply to tags: | ||
| 151 | |||
| 152 | =over | ||
| 153 | |||
| 154 | =item * | ||
| 155 | |||
| 156 | Maximum number of tags per resource - 50 | ||
| 157 | |||
| 158 | =item * | ||
| 159 | |||
| 160 | For each resource, each tag key must be unique, and each tag key can | ||
| 161 | have only one value. | ||
| 162 | |||
| 163 | =item * | ||
| 164 | |||
| 165 | Maximum key length - 128 Unicode characters in UTF-8 | ||
| 166 | |||
| 167 | =item * | ||
| 168 | |||
| 169 | Maximum value length - 256 Unicode characters in UTF-8 | ||
| 170 | |||
| 171 | =item * | ||
| 172 | |||
| 173 | If your tagging schema is used across multiple services and resources, | ||
| 174 | remember that other services may have restrictions on allowed | ||
| 175 | characters. Generally allowed characters are: letters, numbers, and | ||
| 176 | spaces representable in UTF-8, and the following characters: + - = . _ | ||
| 177 | : / @. | ||
| 178 | |||
| 179 | =item * | ||
| 180 | |||
| 181 | Tag keys and values are case-sensitive. | ||
| 182 | |||
| 183 | =item * | ||
| 184 | |||
| 185 | Do not use C<aws:>, C<AWS:>, or any upper or lowercase combination of | ||
| 186 | such as a prefix for either keys or values as it is reserved for AWS | ||
| 187 | use. You cannot edit or delete tag keys or values with this prefix. | ||
| 188 | Tags with this prefix do not count against your tags per resource | ||
| 189 | limit. | ||
| 190 | |||
| 191 | =back | ||
| 192 | |||
| 193 | |||
| 194 | |||
| 195 | |||
| 196 | =head2 TotalResources => ArrayRef[L<Paws::ECS::Resource>] | ||
| 197 | |||
| 198 | The resources available on the instance. | ||
| 199 | |||
| 200 | |||
| 201 | |||
| 202 | =head2 VersionInfo => L<Paws::ECS::VersionInfo> | ||
| 203 | |||
| 204 | The version information for the Amazon ECS container agent and Docker | ||
| 205 | daemon running on the container instance. | ||
| 206 | |||
| 207 | |||
| 208 | |||
| 209 | |||
| 210 | =head1 SEE ALSO | ||
| 211 | |||
| 212 | This class forms part of L<Paws>, documenting arguments for method RegisterContainerInstance in L<Paws::ECS> | ||
| 213 | |||
| 214 | =head1 BUGS and CONTRIBUTIONS | ||
| 215 | |||
| 216 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 217 | |||
| 218 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 219 | |||
| 220 | =cut | ||
| 221 |