« blib/lib/Paws/ImageBuilder/ContainerRecipeSummary.pm
↑ Summary
blib/lib/Paws/ImageBuilder/CreateComponentResponse.pm »
| 1 | |||
| 2 | package Paws::ImageBuilder::CreateComponent; | ||
| 3 | use Moose; | ||
| 4 | has ChangeDescription => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'changeDescription'); | ||
| 5 | has ClientToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'clientToken', required => 1); | ||
| 6 | has Data => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'data'); | ||
| 7 | has Description => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'description'); | ||
| 8 | has KmsKeyId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'kmsKeyId'); | ||
| 9 | has Name => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'name', required => 1); | ||
| 10 | has Platform => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'platform', required => 1); | ||
| 11 | has SemanticVersion => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'semanticVersion', required => 1); | ||
| 12 | has SupportedOsVersions => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'supportedOsVersions'); | ||
| 13 | has Tags => (is => 'ro', isa => 'Paws::ImageBuilder::TagMap', traits => ['NameInRequest'], request_name => 'tags'); | ||
| 14 | has Uri => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'uri'); | ||
| 15 | |||
| 16 | use MooseX::ClassAttribute; | ||
| 17 | |||
| 18 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateComponent'); | ||
| 19 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/CreateComponent'); | ||
| 20 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT'); | ||
| 21 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ImageBuilder::CreateComponentResponse'); | ||
| 22 | 1; | ||
| 23 | |||
| 24 | ### main pod documentation begin ### | ||
| 25 | |||
| 26 | =head1 NAME | ||
| 27 | |||
| 28 | Paws::ImageBuilder::CreateComponent - Arguments for method CreateComponent on L<Paws::ImageBuilder> | ||
| 29 | |||
| 30 | =head1 DESCRIPTION | ||
| 31 | |||
| 32 | This class represents the parameters used for calling the method CreateComponent on the | ||
| 33 | L<EC2 Image Builder|Paws::ImageBuilder> service. Use the attributes of this class | ||
| 34 | as arguments to method CreateComponent. | ||
| 35 | |||
| 36 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateComponent. | ||
| 37 | |||
| 38 | =head1 SYNOPSIS | ||
| 39 | |||
| 40 | my $imagebuilder = Paws->service('ImageBuilder'); | ||
| 41 | my $CreateComponentResponse = $imagebuilder->CreateComponent( | ||
| 42 | ClientToken => 'MyClientToken', | ||
| 43 | Name => 'MyResourceName', | ||
| 44 | Platform => 'Windows', | ||
| 45 | SemanticVersion => 'MyVersionNumber', | ||
| 46 | ChangeDescription => 'MyNonEmptyString', # OPTIONAL | ||
| 47 | Data => 'MyInlineComponentData', # OPTIONAL | ||
| 48 | Description => 'MyNonEmptyString', # OPTIONAL | ||
| 49 | KmsKeyId => 'MyNonEmptyString', # OPTIONAL | ||
| 50 | SupportedOsVersions => [ | ||
| 51 | 'MyOsVersion', ... # min: 1 | ||
| 52 | ], # OPTIONAL | ||
| 53 | Tags => { | ||
| 54 | 'MyTagKey' => 'MyTagValue', # key: min: 1, max: 128, value: max: 256 | ||
| 55 | }, # OPTIONAL | ||
| 56 | Uri => 'MyUri', # OPTIONAL | ||
| 57 | ); | ||
| 58 | |||
| 59 | # Results: | ||
| 60 | my $ClientToken = $CreateComponentResponse->ClientToken; | ||
| 61 | my $ComponentBuildVersionArn = | ||
| 62 | $CreateComponentResponse->ComponentBuildVersionArn; | ||
| 63 | my $RequestId = $CreateComponentResponse->RequestId; | ||
| 64 | |||
| 65 | # Returns a L<Paws::ImageBuilder::CreateComponentResponse> object. | ||
| 66 | |||
| 67 | 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. | ||
| 68 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/imagebuilder/CreateComponent> | ||
| 69 | |||
| 70 | =head1 ATTRIBUTES | ||
| 71 | |||
| 72 | |||
| 73 | =head2 ChangeDescription => Str | ||
| 74 | |||
| 75 | The change description of the component. Describes what change has been | ||
| 76 | made in this version, or what makes this version different from other | ||
| 77 | versions of this component. | ||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head2 B<REQUIRED> ClientToken => Str | ||
| 82 | |||
| 83 | The idempotency token of the component. | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | =head2 Data => Str | ||
| 88 | |||
| 89 | The data of the component. Used to specify the data inline. Either | ||
| 90 | C<data> or C<uri> can be used to specify the data within the component. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head2 Description => Str | ||
| 95 | |||
| 96 | The description of the component. Describes the contents of the | ||
| 97 | component. | ||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | =head2 KmsKeyId => Str | ||
| 102 | |||
| 103 | The ID of the KMS key that should be used to encrypt this component. | ||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | =head2 B<REQUIRED> Name => Str | ||
| 108 | |||
| 109 | The name of the component. | ||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | =head2 B<REQUIRED> Platform => Str | ||
| 114 | |||
| 115 | The platform of the component. | ||
| 116 | |||
| 117 | Valid values are: C<"Windows">, C<"Linux"> | ||
| 118 | |||
| 119 | =head2 B<REQUIRED> SemanticVersion => Str | ||
| 120 | |||
| 121 | The semantic version of the component. This version follows the | ||
| 122 | semantic version syntax. For example, major.minor.patch. This could be | ||
| 123 | versioned like software (2.0.1) or like a date (2019.12.01). | ||
| 124 | |||
| 125 | |||
| 126 | |||
| 127 | =head2 SupportedOsVersions => ArrayRef[Str|Undef] | ||
| 128 | |||
| 129 | The operating system (OS) version supported by the component. If the OS | ||
| 130 | information is available, a prefix match is performed against the | ||
| 131 | parent image OS version during image recipe creation. | ||
| 132 | |||
| 133 | |||
| 134 | |||
| 135 | =head2 Tags => L<Paws::ImageBuilder::TagMap> | ||
| 136 | |||
| 137 | The tags of the component. | ||
| 138 | |||
| 139 | |||
| 140 | |||
| 141 | =head2 Uri => Str | ||
| 142 | |||
| 143 | The uri of the component. Must be an Amazon S3 URL and the requester | ||
| 144 | must have permission to access the Amazon S3 bucket. If you use Amazon | ||
| 145 | S3, you can specify component content up to your service quota. Either | ||
| 146 | C<data> or C<uri> can be used to specify the data within the component. | ||
| 147 | |||
| 148 | |||
| 149 | |||
| 150 | |||
| 151 | =head1 SEE ALSO | ||
| 152 | |||
| 153 | This class forms part of L<Paws>, documenting arguments for method CreateComponent in L<Paws::ImageBuilder> | ||
| 154 | |||
| 155 | =head1 BUGS and CONTRIBUTIONS | ||
| 156 | |||
| 157 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 158 | |||
| 159 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 160 | |||
| 161 | =cut | ||
| 162 |