The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Paws::ImageBuilder::CreateImageRecipe - Arguments for method CreateImageRecipe on Paws::ImageBuilder

DESCRIPTION

This class represents the parameters used for calling the method CreateImageRecipe on the EC2 Image Builder service. Use the attributes of this class as arguments to method CreateImageRecipe.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateImageRecipe.

SYNOPSIS

    my $imagebuilder = Paws->service('ImageBuilder');
    my $CreateImageRecipeResponse = $imagebuilder->CreateImageRecipe(
      ClientToken => 'MyClientToken',
      Components  => [
        {
          ComponentArn => 'MyComponentVersionArnOrBuildVersionArn',
          Parameters   => [
            {
              Name  => 'MyComponentParameterName',    # min: 1, max: 256
              Value => [
                'MyComponentParameterValue', ...      # min: 1
              ],

            },
            ...
          ],    # min: 1; OPTIONAL
        },
        ...
      ],
      Name                            => 'MyResourceName',
      ParentImage                     => 'MyNonEmptyString',
      SemanticVersion                 => 'MyVersionNumber',
      AdditionalInstanceConfiguration => {
        SystemsManagerAgent => {
          UninstallAfterBuild => 1,    # OPTIONAL
        },    # OPTIONAL
        UserDataOverride => 'MyUserDataOverride', # min: 1, max: 21847; OPTIONAL
      },    # OPTIONAL
      BlockDeviceMappings => [
        {
          DeviceName => 'MyNonEmptyString',    # min: 1, max: 1024
          Ebs        => {
            DeleteOnTermination => 1,    # OPTIONAL
            Encrypted           => 1,    # OPTIONAL
            Iops                => 1,    # min: 100, max: 10000; OPTIONAL
            KmsKeyId   => 'MyNonEmptyString',    # min: 1, max: 1024
            SnapshotId => 'MyNonEmptyString',    # min: 1, max: 1024
            VolumeSize => 1,                     # min: 1, max: 16000; OPTIONAL
            VolumeType => 'standard'
            ,    # values: standard, io1, io2, gp2, gp3, sc1, st1; OPTIONAL
          },    # OPTIONAL
          NoDevice    => 'MyEmptyString',       # OPTIONAL
          VirtualName => 'MyNonEmptyString',    # min: 1, max: 1024
        },
        ...
      ],    # OPTIONAL
      Description => 'MyNonEmptyString',    # OPTIONAL
      Tags        => {
        'MyTagKey' => 'MyTagValue',    # key: min: 1, max: 128, value: max: 256
      },    # OPTIONAL
      WorkingDirectory => 'MyNonEmptyString',    # OPTIONAL
    );

    # Results:
    my $ClientToken    = $CreateImageRecipeResponse->ClientToken;
    my $ImageRecipeArn = $CreateImageRecipeResponse->ImageRecipeArn;
    my $RequestId      = $CreateImageRecipeResponse->RequestId;

    # Returns a L<Paws::ImageBuilder::CreateImageRecipeResponse> object.

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. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/imagebuilder/CreateImageRecipe

ATTRIBUTES

AdditionalInstanceConfiguration => Paws::ImageBuilder::AdditionalInstanceConfiguration

Specify additional settings and launch scripts for your build instances.

BlockDeviceMappings => ArrayRef[Paws::ImageBuilder::InstanceBlockDeviceMapping]

The block device mappings of the image recipe.

REQUIRED ClientToken => Str

The idempotency token used to make this request idempotent.

REQUIRED Components => ArrayRef[Paws::ImageBuilder::ComponentConfiguration]

The components of the image recipe.

Description => Str

The description of the image recipe.

REQUIRED Name => Str

The name of the image recipe.

REQUIRED ParentImage => Str

The parent image of the image recipe. The value of the string can be the ARN of the parent image or an AMI ID. The format for the ARN follows this example: arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/x.x.x. You can provide the specific version that you want to use, or you can use a wildcard in all of the fields. If you enter an AMI ID for the string value, you must have access to the AMI, and the AMI must be in the same Region in which you are using Image Builder.

REQUIRED SemanticVersion => Str

The semantic version of the image recipe.

Tags => Paws::ImageBuilder::TagMap

The tags of the image recipe.

WorkingDirectory => Str

The working directory used during build and test workflows.

SEE ALSO

This class forms part of Paws, documenting arguments for method CreateImageRecipe in Paws::ImageBuilder

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues