Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.ImageBuilder.CreateComponent

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new component that can be used to build, validate, test, and assess your image. The component is based on a YAML document that you specify using exactly one of the following methods:

Inline, using the data property in the request body.
A URL that points to a YAML document file stored in Amazon S3, using the uri property in the request body.

Synopsis

data CreateComponent = CreateComponent' {
- changeDescription :: Maybe Text
- data' :: Maybe Text
- description :: Maybe Text
- kmsKeyId :: Maybe Text
- supportedOsVersions :: Maybe (NonEmpty Text)
- tags :: Maybe (HashMap Text Text)
- uri :: Maybe Text
- name :: Text
- semanticVersion :: Text
- platform :: Platform
- clientToken :: Text
}
newCreateComponent :: Text -> Text -> Platform -> Text -> CreateComponent
createComponent_changeDescription :: Lens' CreateComponent (Maybe Text)
createComponent_data :: Lens' CreateComponent (Maybe Text)
createComponent_description :: Lens' CreateComponent (Maybe Text)
createComponent_kmsKeyId :: Lens' CreateComponent (Maybe Text)
createComponent_supportedOsVersions :: Lens' CreateComponent (Maybe (NonEmpty Text))
createComponent_tags :: Lens' CreateComponent (Maybe (HashMap Text Text))
createComponent_uri :: Lens' CreateComponent (Maybe Text)
createComponent_name :: Lens' CreateComponent Text
createComponent_semanticVersion :: Lens' CreateComponent Text
createComponent_platform :: Lens' CreateComponent Platform
createComponent_clientToken :: Lens' CreateComponent Text
data CreateComponentResponse = CreateComponentResponse' {
- clientToken :: Maybe Text
- componentBuildVersionArn :: Maybe Text
- requestId :: Maybe Text
- httpStatus :: Int
}
newCreateComponentResponse :: Int -> CreateComponentResponse
createComponentResponse_clientToken :: Lens' CreateComponentResponse (Maybe Text)
createComponentResponse_componentBuildVersionArn :: Lens' CreateComponentResponse (Maybe Text)
createComponentResponse_requestId :: Lens' CreateComponentResponse (Maybe Text)
createComponentResponse_httpStatus :: Lens' CreateComponentResponse Int

Creating a Request

data CreateComponent Source #

See: newCreateComponent smart constructor.

Constructors

CreateComponent'

Fields

changeDescription :: Maybe Text
The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of this component.
data' :: Maybe Text
Component data contains inline YAML document content for the component. Alternatively, you can specify the uri of a YAML document file stored in Amazon S3. However, you cannot specify both properties.
description :: Maybe Text
The description of the component. Describes the contents of the component.
kmsKeyId :: Maybe Text
The ID of the KMS key that should be used to encrypt this component.
supportedOsVersions :: Maybe (NonEmpty Text)
The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.
tags :: Maybe (HashMap Text Text)
The tags of the component.
uri :: Maybe Text
The uri of a YAML component document file. This must be an S3 URL (s3://bucket/key), and the requester must have permission to access the S3 bucket it points to. If you use Amazon S3, you can specify component content up to your service quota.
Alternatively, you can specify the YAML document inline, using the component data property. You cannot specify both properties.
name :: Text
The name of the component.
semanticVersion :: Text
The semantic version of the component. This version follows the semantic version syntax.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.
Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
platform :: Platform
The platform of the component.
clientToken :: Text
The idempotency token of the component.

Instances

Instances details

ToJSON CreateComponent Source #
Instance details Defined in Amazonka.ImageBuilder.CreateComponent Methods toJSON :: CreateComponent -> Value # toEncoding :: CreateComponent -> Encoding # toJSONList :: [CreateComponent] -> Value # toEncodingList :: [CreateComponent] -> Encoding #
ToHeaders CreateComponent Source #
Instance details Defined in Amazonka.ImageBuilder.CreateComponent Methods toHeaders :: CreateComponent -> [Header] #
ToPath CreateComponent Source #
Instance details Defined in Amazonka.ImageBuilder.CreateComponent Methods toPath :: CreateComponent -> ByteString #
ToQuery CreateComponent Source #
Instance details Defined in Amazonka.ImageBuilder.CreateComponent Methods toQuery :: CreateComponent -> QueryString #
AWSRequest CreateComponent Source #
Instance details Defined in Amazonka.ImageBuilder.CreateComponent Associated Types type AWSResponse CreateComponent # Methods request :: (Service -> Service) -> CreateComponent -> Request CreateComponent # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateComponent -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateComponent))) #
Generic CreateComponent Source #
Instance details Defined in Amazonka.ImageBuilder.CreateComponent Associated Types type Rep CreateComponent :: Type -> Type # Methods from :: CreateComponent -> Rep CreateComponent x # to :: Rep CreateComponent x -> CreateComponent #
Read CreateComponent Source #
Instance details Defined in Amazonka.ImageBuilder.CreateComponent Methods readsPrec :: Int -> ReadS CreateComponent # readList :: ReadS [CreateComponent] # readPrec :: ReadPrec CreateComponent # readListPrec :: ReadPrec [CreateComponent] #
Show CreateComponent Source #
Instance details Defined in Amazonka.ImageBuilder.CreateComponent Methods showsPrec :: Int -> CreateComponent -> ShowS # show :: CreateComponent -> String # showList :: [CreateComponent] -> ShowS #
NFData CreateComponent Source #
Instance details Defined in Amazonka.ImageBuilder.CreateComponent Methods rnf :: CreateComponent -> () #
Eq CreateComponent Source #
Instance details Defined in Amazonka.ImageBuilder.CreateComponent Methods (==) :: CreateComponent -> CreateComponent -> Bool # (/=) :: CreateComponent -> CreateComponent -> Bool #
Hashable CreateComponent Source #
Instance details Defined in Amazonka.ImageBuilder.CreateComponent Methods hashWithSalt :: Int -> CreateComponent -> Int # hash :: CreateComponent -> Int #
type AWSResponse CreateComponent Source #
Instance details Defined in Amazonka.ImageBuilder.CreateComponent type AWSResponse CreateComponent = CreateComponentResponse
type Rep CreateComponent Source #
Instance details Defined in Amazonka.ImageBuilder.CreateComponent type Rep CreateComponent = D1 ('MetaData "CreateComponent" "Amazonka.ImageBuilder.CreateComponent" "amazonka-imagebuilder-2.0-BBLLjX59RW72O8VbQ3vKvH" 'False) (C1 ('MetaCons "CreateComponent'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "changeDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "data'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "supportedOsVersions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text)))))) :: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "uri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: (S1 ('MetaSel ('Just "semanticVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "platform") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Platform) :: S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newCreateComponent Source #

Arguments

:: Text	`CreateComponent`
-> Text	`$sel:semanticVersion:CreateComponent'`
-> Platform	`CreateComponent`
-> Text	`CreateComponent`
-> CreateComponent

Create a value of CreateComponent 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:

CreateComponent, createComponent_changeDescription - The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of this component.

CreateComponent, createComponent_data - Component data contains inline YAML document content for the component. Alternatively, you can specify the uri of a YAML document file stored in Amazon S3. However, you cannot specify both properties.

CreateComponent, createComponent_description - The description of the component. Describes the contents of the component.

CreateComponent, createComponent_kmsKeyId - The ID of the KMS key that should be used to encrypt this component.

CreateComponent, createComponent_supportedOsVersions - The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.

CreateComponent, createComponent_tags - The tags of the component.

$sel:uri:CreateComponent', createComponent_uri - The uri of a YAML component document file. This must be an S3 URL (s3://bucket/key), and the requester must have permission to access the S3 bucket it points to. If you use Amazon S3, you can specify component content up to your service quota.

Alternatively, you can specify the YAML document inline, using the component data property. You cannot specify both properties.

CreateComponent, createComponent_name - The name of the component.

$sel:semanticVersion:CreateComponent', createComponent_semanticVersion - The semantic version of the component. This version follows the semantic version syntax.

The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.

Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.

Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.

CreateComponent, createComponent_platform - The platform of the component.

CreateComponent, createComponent_clientToken - The idempotency token of the component.

Request Lenses

createComponent_changeDescription :: Lens' CreateComponent (Maybe Text) Source #

The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of this component.

createComponent_data :: Lens' CreateComponent (Maybe Text) Source #

Component data contains inline YAML document content for the component. Alternatively, you can specify the uri of a YAML document file stored in Amazon S3. However, you cannot specify both properties.

createComponent_description :: Lens' CreateComponent (Maybe Text) Source #

The description of the component. Describes the contents of the component.

createComponent_kmsKeyId :: Lens' CreateComponent (Maybe Text) Source #

The ID of the KMS key that should be used to encrypt this component.

createComponent_supportedOsVersions :: Lens' CreateComponent (Maybe (NonEmpty Text)) Source #

The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.

createComponent_tags :: Lens' CreateComponent (Maybe (HashMap Text Text)) Source #

The tags of the component.

createComponent_uri :: Lens' CreateComponent (Maybe Text) Source #

The uri of a YAML component document file. This must be an S3 URL (s3://bucket/key), and the requester must have permission to access the S3 bucket it points to. If you use Amazon S3, you can specify component content up to your service quota.

Alternatively, you can specify the YAML document inline, using the component data property. You cannot specify both properties.

createComponent_name :: Lens' CreateComponent Text Source #

The name of the component.

createComponent_semanticVersion :: Lens' CreateComponent Text Source #

The semantic version of the component. This version follows the semantic version syntax.

The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.

Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.

Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.

createComponent_platform :: Lens' CreateComponent Platform Source #

The platform of the component.

createComponent_clientToken :: Lens' CreateComponent Text Source #

The idempotency token of the component.

Destructuring the Response

data CreateComponentResponse Source #

See: newCreateComponentResponse smart constructor.

Constructors

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

Instances

Instances details

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

newCreateComponentResponse Source #

Arguments

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

Create a value of CreateComponentResponse 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:

CreateComponent, createComponentResponse_clientToken - The idempotency token used to make this request idempotent.

$sel:componentBuildVersionArn:CreateComponentResponse', createComponentResponse_componentBuildVersionArn - The Amazon Resource Name (ARN) of the component that was created by this request.

$sel:requestId:CreateComponentResponse', createComponentResponse_requestId - The request ID that uniquely identifies this request.

$sel:httpStatus:CreateComponentResponse', createComponentResponse_httpStatus - The response's http status code.

Response Lenses

createComponentResponse_clientToken :: Lens' CreateComponentResponse (Maybe Text) Source #

The idempotency token used to make this request idempotent.

createComponentResponse_componentBuildVersionArn :: Lens' CreateComponentResponse (Maybe Text) Source #

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

createComponentResponse_requestId :: Lens' CreateComponentResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

createComponentResponse_httpStatus :: Lens' CreateComponentResponse Int Source #

The response's http status code.