« blib/lib/Paws/ImageBuilder/CreateComponentResponse.pm
↑ Summary
blib/lib/Paws/ImageBuilder/CreateContainerRecipeResponse.pm »
| 1 | |||
| 2 | package Paws::ImageBuilder::CreateContainerRecipe; | ||
| 3 | use Moose; | ||
| 4 | has ClientToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'clientToken', required => 1); | ||
| 5 | has Components => (is => 'ro', isa => 'ArrayRef[Paws::ImageBuilder::ComponentConfiguration]', traits => ['NameInRequest'], request_name => 'components', required => 1); | ||
| 6 | has ContainerType => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'containerType', required => 1); | ||
| 7 | has Description => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'description'); | ||
| 8 | has DockerfileTemplateData => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'dockerfileTemplateData'); | ||
| 9 | has DockerfileTemplateUri => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'dockerfileTemplateUri'); | ||
| 10 | has ImageOsVersionOverride => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'imageOsVersionOverride'); | ||
| 11 | has InstanceConfiguration => (is => 'ro', isa => 'Paws::ImageBuilder::InstanceConfiguration', traits => ['NameInRequest'], request_name => 'instanceConfiguration'); | ||
| 12 | has KmsKeyId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'kmsKeyId'); | ||
| 13 | has Name => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'name', required => 1); | ||
| 14 | has ParentImage => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'parentImage', required => 1); | ||
| 15 | has PlatformOverride => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'platformOverride'); | ||
| 16 | has SemanticVersion => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'semanticVersion', required => 1); | ||
| 17 | has Tags => (is => 'ro', isa => 'Paws::ImageBuilder::TagMap', traits => ['NameInRequest'], request_name => 'tags'); | ||
| 18 | has TargetRepository => (is => 'ro', isa => 'Paws::ImageBuilder::TargetContainerRepository', traits => ['NameInRequest'], request_name => 'targetRepository', required => 1); | ||
| 19 | has WorkingDirectory => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'workingDirectory'); | ||
| 20 | |||
| 21 | use MooseX::ClassAttribute; | ||
| 22 | |||
| 23 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateContainerRecipe'); | ||
| 24 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/CreateContainerRecipe'); | ||
| 25 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT'); | ||
| 26 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ImageBuilder::CreateContainerRecipeResponse'); | ||
| 27 | 1; | ||
| 28 | |||
| 29 | ### main pod documentation begin ### | ||
| 30 | |||
| 31 | =head1 NAME | ||
| 32 | |||
| 33 | Paws::ImageBuilder::CreateContainerRecipe - Arguments for method CreateContainerRecipe on L<Paws::ImageBuilder> | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | This class represents the parameters used for calling the method CreateContainerRecipe on the | ||
| 38 | L<EC2 Image Builder|Paws::ImageBuilder> service. Use the attributes of this class | ||
| 39 | as arguments to method CreateContainerRecipe. | ||
| 40 | |||
| 41 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateContainerRecipe. | ||
| 42 | |||
| 43 | =head1 SYNOPSIS | ||
| 44 | |||
| 45 | my $imagebuilder = Paws->service('ImageBuilder'); | ||
| 46 | my $CreateContainerRecipeResponse = $imagebuilder->CreateContainerRecipe( | ||
| 47 | ClientToken => 'MyClientToken', | ||
| 48 | Components => [ | ||
| 49 | { | ||
| 50 | ComponentArn => 'MyComponentVersionArnOrBuildVersionArn', | ||
| 51 | Parameters => [ | ||
| 52 | { | ||
| 53 | Name => 'MyComponentParameterName', # min: 1, max: 256 | ||
| 54 | Value => [ | ||
| 55 | 'MyComponentParameterValue', ... # min: 1 | ||
| 56 | ], | ||
| 57 | |||
| 58 | }, | ||
| 59 | ... | ||
| 60 | ], # min: 1; OPTIONAL | ||
| 61 | }, | ||
| 62 | ... | ||
| 63 | ], | ||
| 64 | ContainerType => 'DOCKER', | ||
| 65 | Name => 'MyResourceName', | ||
| 66 | ParentImage => 'MyNonEmptyString', | ||
| 67 | SemanticVersion => 'MyVersionNumber', | ||
| 68 | TargetRepository => { | ||
| 69 | RepositoryName => 'MyNonEmptyString', # min: 1, max: 1024 | ||
| 70 | Service => 'ECR', # values: ECR | ||
| 71 | |||
| 72 | }, | ||
| 73 | Description => 'MyNonEmptyString', # OPTIONAL | ||
| 74 | DockerfileTemplateData => 'MyInlineDockerFileTemplate', # OPTIONAL | ||
| 75 | DockerfileTemplateUri => 'MyUri', # OPTIONAL | ||
| 76 | ImageOsVersionOverride => 'MyNonEmptyString', # OPTIONAL | ||
| 77 | InstanceConfiguration => { | ||
| 78 | BlockDeviceMappings => [ | ||
| 79 | { | ||
| 80 | DeviceName => 'MyNonEmptyString', # min: 1, max: 1024 | ||
| 81 | Ebs => { | ||
| 82 | DeleteOnTermination => 1, # OPTIONAL | ||
| 83 | Encrypted => 1, # OPTIONAL | ||
| 84 | Iops => 1, # min: 100, max: 10000; OPTIONAL | ||
| 85 | KmsKeyId => 'MyNonEmptyString', # min: 1, max: 1024 | ||
| 86 | SnapshotId => 'MyNonEmptyString', # min: 1, max: 1024 | ||
| 87 | VolumeSize => 1, # min: 1, max: 16000; OPTIONAL | ||
| 88 | VolumeType => 'standard' | ||
| 89 | , # values: standard, io1, io2, gp2, gp3, sc1, st1; OPTIONAL | ||
| 90 | }, # OPTIONAL | ||
| 91 | NoDevice => 'MyEmptyString', # OPTIONAL | ||
| 92 | VirtualName => 'MyNonEmptyString', # min: 1, max: 1024 | ||
| 93 | }, | ||
| 94 | ... | ||
| 95 | ], # OPTIONAL | ||
| 96 | Image => 'MyNonEmptyString', # min: 1, max: 1024 | ||
| 97 | }, # OPTIONAL | ||
| 98 | KmsKeyId => 'MyNonEmptyString', # OPTIONAL | ||
| 99 | PlatformOverride => 'Windows', # OPTIONAL | ||
| 100 | Tags => { | ||
| 101 | 'MyTagKey' => 'MyTagValue', # key: min: 1, max: 128, value: max: 256 | ||
| 102 | }, # OPTIONAL | ||
| 103 | WorkingDirectory => 'MyNonEmptyString', # OPTIONAL | ||
| 104 | ); | ||
| 105 | |||
| 106 | # Results: | ||
| 107 | my $ClientToken = $CreateContainerRecipeResponse->ClientToken; | ||
| 108 | my $ContainerRecipeArn = $CreateContainerRecipeResponse->ContainerRecipeArn; | ||
| 109 | my $RequestId = $CreateContainerRecipeResponse->RequestId; | ||
| 110 | |||
| 111 | # Returns a L<Paws::ImageBuilder::CreateContainerRecipeResponse> object. | ||
| 112 | |||
| 113 | 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. | ||
| 114 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/imagebuilder/CreateContainerRecipe> | ||
| 115 | |||
| 116 | =head1 ATTRIBUTES | ||
| 117 | |||
| 118 | |||
| 119 | =head2 B<REQUIRED> ClientToken => Str | ||
| 120 | |||
| 121 | The client token used to make this request idempotent. | ||
| 122 | |||
| 123 | |||
| 124 | |||
| 125 | =head2 B<REQUIRED> Components => ArrayRef[L<Paws::ImageBuilder::ComponentConfiguration>] | ||
| 126 | |||
| 127 | Components for build and test that are included in the container | ||
| 128 | recipe. | ||
| 129 | |||
| 130 | |||
| 131 | |||
| 132 | =head2 B<REQUIRED> ContainerType => Str | ||
| 133 | |||
| 134 | The type of container to create. | ||
| 135 | |||
| 136 | Valid values are: C<"DOCKER"> | ||
| 137 | |||
| 138 | =head2 Description => Str | ||
| 139 | |||
| 140 | The description of the container recipe. | ||
| 141 | |||
| 142 | |||
| 143 | |||
| 144 | =head2 DockerfileTemplateData => Str | ||
| 145 | |||
| 146 | The Dockerfile template used to build your image as an inline data | ||
| 147 | blob. | ||
| 148 | |||
| 149 | |||
| 150 | |||
| 151 | =head2 DockerfileTemplateUri => Str | ||
| 152 | |||
| 153 | The Amazon S3 URI for the Dockerfile that will be used to build your | ||
| 154 | container image. | ||
| 155 | |||
| 156 | |||
| 157 | |||
| 158 | =head2 ImageOsVersionOverride => Str | ||
| 159 | |||
| 160 | Specifies the operating system version for the source image. | ||
| 161 | |||
| 162 | |||
| 163 | |||
| 164 | =head2 InstanceConfiguration => L<Paws::ImageBuilder::InstanceConfiguration> | ||
| 165 | |||
| 166 | A group of options that can be used to configure an instance for | ||
| 167 | building and testing container images. | ||
| 168 | |||
| 169 | |||
| 170 | |||
| 171 | =head2 KmsKeyId => Str | ||
| 172 | |||
| 173 | Identifies which KMS key is used to encrypt the container image. | ||
| 174 | |||
| 175 | |||
| 176 | |||
| 177 | =head2 B<REQUIRED> Name => Str | ||
| 178 | |||
| 179 | The name of the container recipe. | ||
| 180 | |||
| 181 | |||
| 182 | |||
| 183 | =head2 B<REQUIRED> ParentImage => Str | ||
| 184 | |||
| 185 | The source image for the container recipe. | ||
| 186 | |||
| 187 | |||
| 188 | |||
| 189 | =head2 PlatformOverride => Str | ||
| 190 | |||
| 191 | Specifies the operating system platform when you use a custom source | ||
| 192 | image. | ||
| 193 | |||
| 194 | Valid values are: C<"Windows">, C<"Linux"> | ||
| 195 | |||
| 196 | =head2 B<REQUIRED> SemanticVersion => Str | ||
| 197 | |||
| 198 | The semantic version of the container recipe | ||
| 199 | (E<lt>majorE<gt>.E<lt>minorE<gt>.E<lt>patchE<gt>). | ||
| 200 | |||
| 201 | |||
| 202 | |||
| 203 | =head2 Tags => L<Paws::ImageBuilder::TagMap> | ||
| 204 | |||
| 205 | Tags that are attached to the container recipe. | ||
| 206 | |||
| 207 | |||
| 208 | |||
| 209 | =head2 B<REQUIRED> TargetRepository => L<Paws::ImageBuilder::TargetContainerRepository> | ||
| 210 | |||
| 211 | The destination repository for the container image. | ||
| 212 | |||
| 213 | |||
| 214 | |||
| 215 | =head2 WorkingDirectory => Str | ||
| 216 | |||
| 217 | The working directory for use during build and test workflows. | ||
| 218 | |||
| 219 | |||
| 220 | |||
| 221 | |||
| 222 | =head1 SEE ALSO | ||
| 223 | |||
| 224 | This class forms part of L<Paws>, documenting arguments for method CreateContainerRecipe in L<Paws::ImageBuilder> | ||
| 225 | |||
| 226 | =head1 BUGS and CONTRIBUTIONS | ||
| 227 | |||
| 228 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 229 | |||
| 230 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 231 | |||
| 232 | =cut | ||
| 233 |