Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.ImageBuilder.CreateImage

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new image. This request will create a new image along with all of the configured output resources defined in the distribution configuration. You must specify exactly one recipe for your image, using either a ContainerRecipeArn or an ImageRecipeArn.

Synopsis

data CreateImage = CreateImage' {
- containerRecipeArn :: Maybe Text
- imageTestsConfiguration :: Maybe ImageTestsConfiguration
- enhancedImageMetadataEnabled :: Maybe Bool
- distributionConfigurationArn :: Maybe Text
- imageRecipeArn :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- infrastructureConfigurationArn :: Text
- clientToken :: Text
}
newCreateImage :: Text -> Text -> CreateImage
createImage_containerRecipeArn :: Lens' CreateImage (Maybe Text)
createImage_imageTestsConfiguration :: Lens' CreateImage (Maybe ImageTestsConfiguration)
createImage_enhancedImageMetadataEnabled :: Lens' CreateImage (Maybe Bool)
createImage_distributionConfigurationArn :: Lens' CreateImage (Maybe Text)
createImage_imageRecipeArn :: Lens' CreateImage (Maybe Text)
createImage_tags :: Lens' CreateImage (Maybe (HashMap Text Text))
createImage_infrastructureConfigurationArn :: Lens' CreateImage Text
createImage_clientToken :: Lens' CreateImage Text
data CreateImageResponse = CreateImageResponse' {
- requestId :: Maybe Text
- clientToken :: Maybe Text
- imageBuildVersionArn :: Maybe Text
- httpStatus :: Int
}
newCreateImageResponse :: Int -> CreateImageResponse
createImageResponse_requestId :: Lens' CreateImageResponse (Maybe Text)
createImageResponse_clientToken :: Lens' CreateImageResponse (Maybe Text)
createImageResponse_imageBuildVersionArn :: Lens' CreateImageResponse (Maybe Text)
createImageResponse_httpStatus :: Lens' CreateImageResponse Int

Creating a Request

data CreateImage Source #

See: newCreateImage smart constructor.

Constructors

CreateImage'

Fields

containerRecipeArn :: Maybe Text
The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
imageTestsConfiguration :: Maybe ImageTestsConfiguration
The image tests configuration of the image.
enhancedImageMetadataEnabled :: Maybe Bool
Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.
distributionConfigurationArn :: Maybe Text
The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.
imageRecipeArn :: Maybe Text
The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
tags :: Maybe (HashMap Text Text)
The tags of the image.
infrastructureConfigurationArn :: Text
The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.
clientToken :: Text
The idempotency token used to make this request idempotent.

Instances

Instances details

Eq CreateImage Source #
Instance details Defined in Amazonka.ImageBuilder.CreateImage Methods (==) :: CreateImage -> CreateImage -> Bool # (/=) :: CreateImage -> CreateImage -> Bool #
Read CreateImage Source #
Instance details Defined in Amazonka.ImageBuilder.CreateImage Methods readsPrec :: Int -> ReadS CreateImage # readList :: ReadS [CreateImage] # readPrec :: ReadPrec CreateImage # readListPrec :: ReadPrec [CreateImage] #
Show CreateImage Source #
Instance details Defined in Amazonka.ImageBuilder.CreateImage Methods showsPrec :: Int -> CreateImage -> ShowS # show :: CreateImage -> String # showList :: [CreateImage] -> ShowS #
Generic CreateImage Source #
Instance details Defined in Amazonka.ImageBuilder.CreateImage Associated Types type Rep CreateImage :: Type -> Type # Methods from :: CreateImage -> Rep CreateImage x # to :: Rep CreateImage x -> CreateImage #
NFData CreateImage Source #
Instance details Defined in Amazonka.ImageBuilder.CreateImage Methods rnf :: CreateImage -> () #
Hashable CreateImage Source #
Instance details Defined in Amazonka.ImageBuilder.CreateImage Methods hashWithSalt :: Int -> CreateImage -> Int # hash :: CreateImage -> Int #
ToJSON CreateImage Source #
Instance details Defined in Amazonka.ImageBuilder.CreateImage Methods toJSON :: CreateImage -> Value # toEncoding :: CreateImage -> Encoding # toJSONList :: [CreateImage] -> Value # toEncodingList :: [CreateImage] -> Encoding #
AWSRequest CreateImage Source #
Instance details Defined in Amazonka.ImageBuilder.CreateImage Associated Types type AWSResponse CreateImage # Methods request :: CreateImage -> Request CreateImage # response :: MonadResource m => Logger -> Service -> Proxy CreateImage -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateImage))) #
ToHeaders CreateImage Source #
Instance details Defined in Amazonka.ImageBuilder.CreateImage Methods toHeaders :: CreateImage -> [Header] #
ToPath CreateImage Source #
Instance details Defined in Amazonka.ImageBuilder.CreateImage Methods toPath :: CreateImage -> ByteString #
ToQuery CreateImage Source #
Instance details Defined in Amazonka.ImageBuilder.CreateImage Methods toQuery :: CreateImage -> QueryString #
type Rep CreateImage Source #
Instance details Defined in Amazonka.ImageBuilder.CreateImage type Rep CreateImage = D1 ('MetaData "CreateImage" "Amazonka.ImageBuilder.CreateImage" "libZSservicesZSamazonka-imagebuilderZSamazonka-imagebuilder" 'False) (C1 ('MetaCons "CreateImage'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "containerRecipeArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "imageTestsConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ImageTestsConfiguration))) :: (S1 ('MetaSel ('Just "enhancedImageMetadataEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "distributionConfigurationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "imageRecipeArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "infrastructureConfigurationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse CreateImage Source #
Instance details Defined in Amazonka.ImageBuilder.CreateImage type AWSResponse CreateImage = CreateImageResponse

newCreateImage Source #

Arguments

:: Text	`$sel:infrastructureConfigurationArn:CreateImage'`
-> Text	`$sel:clientToken:CreateImage'`
-> CreateImage

Create a value of CreateImage with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:containerRecipeArn:CreateImage', createImage_containerRecipeArn - The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.

$sel:imageTestsConfiguration:CreateImage', createImage_imageTestsConfiguration - The image tests configuration of the image.

$sel:enhancedImageMetadataEnabled:CreateImage', createImage_enhancedImageMetadataEnabled - Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.

$sel:distributionConfigurationArn:CreateImage', createImage_distributionConfigurationArn - The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.

$sel:imageRecipeArn:CreateImage', createImage_imageRecipeArn - The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.

$sel:tags:CreateImage', createImage_tags - The tags of the image.

$sel:infrastructureConfigurationArn:CreateImage', createImage_infrastructureConfigurationArn - The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.

$sel:clientToken:CreateImage', createImage_clientToken - The idempotency token used to make this request idempotent.

Request Lenses

createImage_containerRecipeArn :: Lens' CreateImage (Maybe Text) Source #

The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.

createImage_imageTestsConfiguration :: Lens' CreateImage (Maybe ImageTestsConfiguration) Source #

The image tests configuration of the image.

createImage_enhancedImageMetadataEnabled :: Lens' CreateImage (Maybe Bool) Source #

Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.

createImage_distributionConfigurationArn :: Lens' CreateImage (Maybe Text) Source #

The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.

createImage_imageRecipeArn :: Lens' CreateImage (Maybe Text) Source #

The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.

createImage_tags :: Lens' CreateImage (Maybe (HashMap Text Text)) Source #

The tags of the image.

createImage_infrastructureConfigurationArn :: Lens' CreateImage Text Source #

The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.

createImage_clientToken :: Lens' CreateImage Text Source #

The idempotency token used to make this request idempotent.

Destructuring the Response

data CreateImageResponse Source #

See: newCreateImageResponse smart constructor.

Constructors

CreateImageResponse'
Fields requestId :: Maybe Text The request ID that uniquely identifies this request. clientToken :: Maybe Text The idempotency token used to make this request idempotent. imageBuildVersionArn :: Maybe Text The Amazon Resource Name (ARN) of the image that was created by this request. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq CreateImageResponse Source #
Instance details Defined in Amazonka.ImageBuilder.CreateImage Methods (==) :: CreateImageResponse -> CreateImageResponse -> Bool # (/=) :: CreateImageResponse -> CreateImageResponse -> Bool #
Read CreateImageResponse Source #
Instance details Defined in Amazonka.ImageBuilder.CreateImage Methods readsPrec :: Int -> ReadS CreateImageResponse # readList :: ReadS [CreateImageResponse] # readPrec :: ReadPrec CreateImageResponse # readListPrec :: ReadPrec [CreateImageResponse] #
Show CreateImageResponse Source #
Instance details Defined in Amazonka.ImageBuilder.CreateImage Methods showsPrec :: Int -> CreateImageResponse -> ShowS # show :: CreateImageResponse -> String # showList :: [CreateImageResponse] -> ShowS #
Generic CreateImageResponse Source #
Instance details Defined in Amazonka.ImageBuilder.CreateImage Associated Types type Rep CreateImageResponse :: Type -> Type # Methods from :: CreateImageResponse -> Rep CreateImageResponse x # to :: Rep CreateImageResponse x -> CreateImageResponse #
NFData CreateImageResponse Source #
Instance details Defined in Amazonka.ImageBuilder.CreateImage Methods rnf :: CreateImageResponse -> () #
type Rep CreateImageResponse Source #
Instance details Defined in Amazonka.ImageBuilder.CreateImage type Rep CreateImageResponse = D1 ('MetaData "CreateImageResponse" "Amazonka.ImageBuilder.CreateImage" "libZSservicesZSamazonka-imagebuilderZSamazonka-imagebuilder" 'False) (C1 ('MetaCons "CreateImageResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "imageBuildVersionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateImageResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateImageResponse'`
-> CreateImageResponse

Create a value of CreateImageResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:requestId:CreateImageResponse', createImageResponse_requestId - The request ID that uniquely identifies this request.

$sel:clientToken:CreateImage', createImageResponse_clientToken - The idempotency token used to make this request idempotent.

$sel:imageBuildVersionArn:CreateImageResponse', createImageResponse_imageBuildVersionArn - The Amazon Resource Name (ARN) of the image that was created by this request.

$sel:httpStatus:CreateImageResponse', createImageResponse_httpStatus - The response's http status code.

Response Lenses

createImageResponse_requestId :: Lens' CreateImageResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

createImageResponse_clientToken :: Lens' CreateImageResponse (Maybe Text) Source #

The idempotency token used to make this request idempotent.

createImageResponse_imageBuildVersionArn :: Lens' CreateImageResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the image that was created by this request.

createImageResponse_httpStatus :: Lens' CreateImageResponse Int Source #

The response's http status code.