« blib/lib/Paws/ImageBuilder/CreateImagePipelineResponse.pm
↑ Summary
blib/lib/Paws/ImageBuilder/CreateImageRecipeResponse.pm »
| 1 | |||
| 2 | package Paws::ImageBuilder::CreateImageRecipe; | ||
| 3 | use Moose; | ||
| 4 | has AdditionalInstanceConfiguration => (is => 'ro', isa => 'Paws::ImageBuilder::AdditionalInstanceConfiguration', traits => ['NameInRequest'], request_name => 'additionalInstanceConfiguration'); | ||
| 5 | has BlockDeviceMappings => (is => 'ro', isa => 'ArrayRef[Paws::ImageBuilder::InstanceBlockDeviceMapping]', traits => ['NameInRequest'], request_name => 'blockDeviceMappings'); | ||
| 6 | has ClientToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'clientToken', required => 1); | ||
| 7 | has Components => (is => 'ro', isa => 'ArrayRef[Paws::ImageBuilder::ComponentConfiguration]', traits => ['NameInRequest'], request_name => 'components', required => 1); | ||
| 8 | has Description => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'description'); | ||
| 9 | has Name => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'name', required => 1); | ||
| 10 | has ParentImage => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'parentImage', required => 1); | ||
| 11 | has SemanticVersion => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'semanticVersion', required => 1); | ||
| 12 | has Tags => (is => 'ro', isa => 'Paws::ImageBuilder::TagMap', traits => ['NameInRequest'], request_name => 'tags'); | ||
| 13 | has WorkingDirectory => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'workingDirectory'); | ||
| 14 | |||
| 15 | use MooseX::ClassAttribute; | ||
| 16 | |||
| 17 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateImageRecipe'); | ||
| 18 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/CreateImageRecipe'); | ||
| 19 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT'); | ||
| 20 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ImageBuilder::CreateImageRecipeResponse'); | ||
| 21 | 1; | ||
| 22 | |||
| 23 | ### main pod documentation begin ### | ||
| 24 | |||
| 25 | =head1 NAME | ||
| 26 | |||
| 27 | Paws::ImageBuilder::CreateImageRecipe - Arguments for method CreateImageRecipe on L<Paws::ImageBuilder> | ||
| 28 | |||
| 29 | =head1 DESCRIPTION | ||
| 30 | |||
| 31 | This class represents the parameters used for calling the method CreateImageRecipe on the | ||
| 32 | L<EC2 Image Builder|Paws::ImageBuilder> service. Use the attributes of this class | ||
| 33 | as arguments to method CreateImageRecipe. | ||
| 34 | |||
| 35 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateImageRecipe. | ||
| 36 | |||
| 37 | =head1 SYNOPSIS | ||
| 38 | |||
| 39 | my $imagebuilder = Paws->service('ImageBuilder'); | ||
| 40 | my $CreateImageRecipeResponse = $imagebuilder->CreateImageRecipe( | ||
| 41 | ClientToken => 'MyClientToken', | ||
| 42 | Components => [ | ||
| 43 | { | ||
| 44 | ComponentArn => 'MyComponentVersionArnOrBuildVersionArn', | ||
| 45 | Parameters => [ | ||
| 46 | { | ||
| 47 | Name => 'MyComponentParameterName', # min: 1, max: 256 | ||
| 48 | Value => [ | ||
| 49 | 'MyComponentParameterValue', ... # min: 1 | ||
| 50 | ], | ||
| 51 | |||
| 52 | }, | ||
| 53 | ... | ||
| 54 | ], # min: 1; OPTIONAL | ||
| 55 | }, | ||
| 56 | ... | ||
| 57 | ], | ||
| 58 | Name => 'MyResourceName', | ||
| 59 | ParentImage => 'MyNonEmptyString', | ||
| 60 | SemanticVersion => 'MyVersionNumber', | ||
| 61 | AdditionalInstanceConfiguration => { | ||
| 62 | SystemsManagerAgent => { | ||
| 63 | UninstallAfterBuild => 1, # OPTIONAL | ||
| 64 | }, # OPTIONAL | ||
| 65 | UserDataOverride => 'MyUserDataOverride', # min: 1, max: 21847; OPTIONAL | ||
| 66 | }, # OPTIONAL | ||
| 67 | BlockDeviceMappings => [ | ||
| 68 | { | ||
| 69 | DeviceName => 'MyNonEmptyString', # min: 1, max: 1024 | ||
| 70 | Ebs => { | ||
| 71 | DeleteOnTermination => 1, # OPTIONAL | ||
| 72 | Encrypted => 1, # OPTIONAL | ||
| 73 | Iops => 1, # min: 100, max: 10000; OPTIONAL | ||
| 74 | KmsKeyId => 'MyNonEmptyString', # min: 1, max: 1024 | ||
| 75 | SnapshotId => 'MyNonEmptyString', # min: 1, max: 1024 | ||
| 76 | VolumeSize => 1, # min: 1, max: 16000; OPTIONAL | ||
| 77 | VolumeType => 'standard' | ||
| 78 | , # values: standard, io1, io2, gp2, gp3, sc1, st1; OPTIONAL | ||
| 79 | }, # OPTIONAL | ||
| 80 | NoDevice => 'MyEmptyString', # OPTIONAL | ||
| 81 | VirtualName => 'MyNonEmptyString', # min: 1, max: 1024 | ||
| 82 | }, | ||
| 83 | ... | ||
| 84 | ], # OPTIONAL | ||
| 85 | Description => 'MyNonEmptyString', # OPTIONAL | ||
| 86 | Tags => { | ||
| 87 | 'MyTagKey' => 'MyTagValue', # key: min: 1, max: 128, value: max: 256 | ||
| 88 | }, # OPTIONAL | ||
| 89 | WorkingDirectory => 'MyNonEmptyString', # OPTIONAL | ||
| 90 | ); | ||
| 91 | |||
| 92 | # Results: | ||
| 93 | my $ClientToken = $CreateImageRecipeResponse->ClientToken; | ||
| 94 | my $ImageRecipeArn = $CreateImageRecipeResponse->ImageRecipeArn; | ||
| 95 | my $RequestId = $CreateImageRecipeResponse->RequestId; | ||
| 96 | |||
| 97 | # Returns a L<Paws::ImageBuilder::CreateImageRecipeResponse> object. | ||
| 98 | |||
| 99 | 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. | ||
| 100 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/imagebuilder/CreateImageRecipe> | ||
| 101 | |||
| 102 | =head1 ATTRIBUTES | ||
| 103 | |||
| 104 | |||
| 105 | =head2 AdditionalInstanceConfiguration => L<Paws::ImageBuilder::AdditionalInstanceConfiguration> | ||
| 106 | |||
| 107 | Specify additional settings and launch scripts for your build | ||
| 108 | instances. | ||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | =head2 BlockDeviceMappings => ArrayRef[L<Paws::ImageBuilder::InstanceBlockDeviceMapping>] | ||
| 113 | |||
| 114 | The block device mappings of the image recipe. | ||
| 115 | |||
| 116 | |||
| 117 | |||
| 118 | =head2 B<REQUIRED> ClientToken => Str | ||
| 119 | |||
| 120 | The idempotency token used to make this request idempotent. | ||
| 121 | |||
| 122 | |||
| 123 | |||
| 124 | =head2 B<REQUIRED> Components => ArrayRef[L<Paws::ImageBuilder::ComponentConfiguration>] | ||
| 125 | |||
| 126 | The components of the image recipe. | ||
| 127 | |||
| 128 | |||
| 129 | |||
| 130 | =head2 Description => Str | ||
| 131 | |||
| 132 | The description of the image recipe. | ||
| 133 | |||
| 134 | |||
| 135 | |||
| 136 | =head2 B<REQUIRED> Name => Str | ||
| 137 | |||
| 138 | The name of the image recipe. | ||
| 139 | |||
| 140 | |||
| 141 | |||
| 142 | =head2 B<REQUIRED> ParentImage => Str | ||
| 143 | |||
| 144 | The parent image of the image recipe. The value of the string can be | ||
| 145 | the ARN of the parent image or an AMI ID. The format for the ARN | ||
| 146 | follows this example: | ||
| 147 | C<arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/x.x.x>. | ||
| 148 | You can provide the specific version that you want to use, or you can | ||
| 149 | use a wildcard in all of the fields. If you enter an AMI ID for the | ||
| 150 | string value, you must have access to the AMI, and the AMI must be in | ||
| 151 | the same Region in which you are using Image Builder. | ||
| 152 | |||
| 153 | |||
| 154 | |||
| 155 | =head2 B<REQUIRED> SemanticVersion => Str | ||
| 156 | |||
| 157 | The semantic version of the image recipe. | ||
| 158 | |||
| 159 | |||
| 160 | |||
| 161 | =head2 Tags => L<Paws::ImageBuilder::TagMap> | ||
| 162 | |||
| 163 | The tags of the image recipe. | ||
| 164 | |||
| 165 | |||
| 166 | |||
| 167 | =head2 WorkingDirectory => Str | ||
| 168 | |||
| 169 | The working directory used during build and test workflows. | ||
| 170 | |||
| 171 | |||
| 172 | |||
| 173 | |||
| 174 | =head1 SEE ALSO | ||
| 175 | |||
| 176 | This class forms part of L<Paws>, documenting arguments for method CreateImageRecipe in L<Paws::ImageBuilder> | ||
| 177 | |||
| 178 | =head1 BUGS and CONTRIBUTIONS | ||
| 179 | |||
| 180 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 181 | |||
| 182 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 183 | |||
| 184 | =cut | ||
| 185 |