« blib/lib/Paws/ImageBuilder/CreateDistributionConfigurationResponse.pm
↑ Summary
blib/lib/Paws/ImageBuilder/CreateImagePipeline.pm »
| 1 | |||
| 2 | package Paws::ImageBuilder::CreateImage; | ||
| 3 | use Moose; | ||
| 4 | has ClientToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'clientToken', required => 1); | ||
| 5 | has ContainerRecipeArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'containerRecipeArn'); | ||
| 6 | has DistributionConfigurationArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'distributionConfigurationArn'); | ||
| 7 | has EnhancedImageMetadataEnabled => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'enhancedImageMetadataEnabled'); | ||
| 8 | has ImageRecipeArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'imageRecipeArn'); | ||
| 9 | has ImageTestsConfiguration => (is => 'ro', isa => 'Paws::ImageBuilder::ImageTestsConfiguration', traits => ['NameInRequest'], request_name => 'imageTestsConfiguration'); | ||
| 10 | has InfrastructureConfigurationArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'infrastructureConfigurationArn', required => 1); | ||
| 11 | has Tags => (is => 'ro', isa => 'Paws::ImageBuilder::TagMap', traits => ['NameInRequest'], request_name => 'tags'); | ||
| 12 | |||
| 13 | use MooseX::ClassAttribute; | ||
| 14 | |||
| 15 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateImage'); | ||
| 16 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/CreateImage'); | ||
| 17 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT'); | ||
| 18 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ImageBuilder::CreateImageResponse'); | ||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::ImageBuilder::CreateImage - Arguments for method CreateImage on L<Paws::ImageBuilder> | ||
| 26 | |||
| 27 | =head1 DESCRIPTION | ||
| 28 | |||
| 29 | This class represents the parameters used for calling the method CreateImage on the | ||
| 30 | L<EC2 Image Builder|Paws::ImageBuilder> service. Use the attributes of this class | ||
| 31 | as arguments to method CreateImage. | ||
| 32 | |||
| 33 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateImage. | ||
| 34 | |||
| 35 | =head1 SYNOPSIS | ||
| 36 | |||
| 37 | my $imagebuilder = Paws->service('ImageBuilder'); | ||
| 38 | my $CreateImageResponse = $imagebuilder->CreateImage( | ||
| 39 | ClientToken => 'MyClientToken', | ||
| 40 | InfrastructureConfigurationArn => 'MyInfrastructureConfigurationArn', | ||
| 41 | ContainerRecipeArn => 'MyContainerRecipeArn', # OPTIONAL | ||
| 42 | DistributionConfigurationArn => | ||
| 43 | 'MyDistributionConfigurationArn', # OPTIONAL | ||
| 44 | EnhancedImageMetadataEnabled => 1, # OPTIONAL | ||
| 45 | ImageRecipeArn => 'MyImageRecipeArn', # OPTIONAL | ||
| 46 | ImageTestsConfiguration => { | ||
| 47 | ImageTestsEnabled => 1, | ||
| 48 | TimeoutMinutes => 1, # min: 60, max: 1440; OPTIONAL | ||
| 49 | }, # OPTIONAL | ||
| 50 | Tags => { | ||
| 51 | 'MyTagKey' => 'MyTagValue', # key: min: 1, max: 128, value: max: 256 | ||
| 52 | }, # OPTIONAL | ||
| 53 | ); | ||
| 54 | |||
| 55 | # Results: | ||
| 56 | my $ClientToken = $CreateImageResponse->ClientToken; | ||
| 57 | my $ImageBuildVersionArn = $CreateImageResponse->ImageBuildVersionArn; | ||
| 58 | my $RequestId = $CreateImageResponse->RequestId; | ||
| 59 | |||
| 60 | # Returns a L<Paws::ImageBuilder::CreateImageResponse> object. | ||
| 61 | |||
| 62 | 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. | ||
| 63 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/imagebuilder/CreateImage> | ||
| 64 | |||
| 65 | =head1 ATTRIBUTES | ||
| 66 | |||
| 67 | |||
| 68 | =head2 B<REQUIRED> ClientToken => Str | ||
| 69 | |||
| 70 | The idempotency token used to make this request idempotent. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head2 ContainerRecipeArn => Str | ||
| 75 | |||
| 76 | The Amazon Resource Name (ARN) of the container recipe that defines how | ||
| 77 | images are configured and tested. | ||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head2 DistributionConfigurationArn => Str | ||
| 82 | |||
| 83 | The Amazon Resource Name (ARN) of the distribution configuration that | ||
| 84 | defines and configures the outputs of your pipeline. | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head2 EnhancedImageMetadataEnabled => Bool | ||
| 89 | |||
| 90 | Collects additional information about the image being created, | ||
| 91 | including the operating system (OS) version and package list. This | ||
| 92 | information is used to enhance the overall experience of using EC2 | ||
| 93 | Image Builder. Enabled by default. | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | =head2 ImageRecipeArn => Str | ||
| 98 | |||
| 99 | The Amazon Resource Name (ARN) of the image recipe that defines how | ||
| 100 | images are configured, tested, and assessed. | ||
| 101 | |||
| 102 | |||
| 103 | |||
| 104 | =head2 ImageTestsConfiguration => L<Paws::ImageBuilder::ImageTestsConfiguration> | ||
| 105 | |||
| 106 | The image tests configuration of the image. | ||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | =head2 B<REQUIRED> InfrastructureConfigurationArn => Str | ||
| 111 | |||
| 112 | The Amazon Resource Name (ARN) of the infrastructure configuration that | ||
| 113 | defines the environment in which your image will be built and tested. | ||
| 114 | |||
| 115 | |||
| 116 | |||
| 117 | =head2 Tags => L<Paws::ImageBuilder::TagMap> | ||
| 118 | |||
| 119 | The tags of the image. | ||
| 120 | |||
| 121 | |||
| 122 | |||
| 123 | |||
| 124 | =head1 SEE ALSO | ||
| 125 | |||
| 126 | This class forms part of L<Paws>, documenting arguments for method CreateImage in L<Paws::ImageBuilder> | ||
| 127 | |||
| 128 | =head1 BUGS and CONTRIBUTIONS | ||
| 129 | |||
| 130 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 131 | |||
| 132 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 133 | |||
| 134 | =cut | ||
| 135 |