software.amazon.awscdk.services.imagebuilder

Class CfnComponent

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.imagebuilder.CfnComponent

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-02-09T02:14:25.476Z")
public class CfnComponent
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ImageBuilder::Component`.

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.imagebuilder.*;
 CfnComponent cfnComponent = CfnComponent.Builder.create(this, "MyCfnComponent")
         .name("name")
         .platform("platform")
         .version("version")
         // the properties below are optional
         .changeDescription("changeDescription")
         .data("data")
         .description("description")
         .kmsKeyId("kmsKeyId")
         .supportedOsVersions(List.of("supportedOsVersions"))
         .tags(Map.of(
                 "tagsKey", "tags"))
         .uri("uri")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnComponent.Builder A fluent builder for CfnComponent.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnComponent(Construct scope, java.lang.String id, CfnComponentProps props) Create a new `AWS::ImageBuilder::Component`.
protected	CfnComponent(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnComponent(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrArn() Returns the Amazon Resource Name (ARN) of the component.
IResolvable	getAttrEncrypted() Returns the encryption status of the component.
java.lang.String	getAttrName() Returns the name of the component.
java.lang.String	getAttrType() Image Builder determines the component type based on the phases that are defined in the component document.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getChangeDescription() The change description of the component.
java.lang.String	getData() Component `data` contains inline YAML document content for the component.
java.lang.String	getDescription() Describes the contents of the component.
java.lang.String	getKmsKeyId() The ID of the KMS key that is used to encrypt this component.
java.lang.String	getName() The name of the component.
java.lang.String	getPlatform() The operating system platform of the component.
java.util.List<java.lang.String>	getSupportedOsVersions() The operating system (OS) version supported by the component.
TagManager	getTags() The tags that apply to the component.
java.lang.String	getUri() The `uri` of a YAML component document file.
java.lang.String	getVersion() The component version.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setChangeDescription(java.lang.String value) The change description of the component.
void	setData(java.lang.String value) Component `data` contains inline YAML document content for the component.
void	setDescription(java.lang.String value) Describes the contents of the component.
void	setKmsKeyId(java.lang.String value) The ID of the KMS key that is used to encrypt this component.
void	setName(java.lang.String value) The name of the component.
void	setPlatform(java.lang.String value) The operating system platform of the component.
void	setSupportedOsVersions(java.util.List<java.lang.String> value) The operating system (OS) version supported by the component.
void	setUri(java.lang.String value) The `uri` of a YAML component document file.
void	setVersion(java.lang.String value) The component version.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnComponent

protected CfnComponent(software.amazon.jsii.JsiiObjectRef objRef)

CfnComponent

protected CfnComponent(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnComponent

public CfnComponent(Construct scope,
                    java.lang.String id,
                    CfnComponentProps props)

Create a new `AWS::ImageBuilder::Component`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

public java.lang.String getAttrArn()

Returns the Amazon Resource Name (ARN) of the component.

The following pattern is applied: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:\d{12}|aws):(?:image-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline)/[a-z0-9-_]+(?:/(?:(?:x|\d+)\.(?:x|\d+)\.(?:x|\d+))(?:/\d+)?)?$ .

getAttrEncrypted

public IResolvable getAttrEncrypted()

Returns the encryption status of the component.

For example true or false .

getAttrName

public java.lang.String getAttrName()

Returns the name of the component.

getAttrType

public java.lang.String getAttrType()

Image Builder determines the component type based on the phases that are defined in the component document.

If there is only one phase, and its name is "test", then the type is TEST . For all other components, the type is BUILD .

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

The tags that apply to the component.

getName

public java.lang.String getName()

The name of the component.

setName

public void setName(java.lang.String value)

The name of the component.

getPlatform

public java.lang.String getPlatform()

The operating system platform of the component.

setPlatform

public void setPlatform(java.lang.String value)

The operating system platform of the component.

getVersion

public java.lang.String getVersion()

The component version.

For example, 1.0.0 .

setVersion

public void setVersion(java.lang.String value)

The component version.

For example, 1.0.0 .

getChangeDescription

public java.lang.String getChangeDescription()

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.

setChangeDescription

public void setChangeDescription(java.lang.String value)

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.

getData

public java.lang.String getData()

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.

setData

public void setData(java.lang.String value)

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.

getDescription

public java.lang.String getDescription()

Describes the contents of the component.

setDescription

public void setDescription(java.lang.String value)

Describes the contents of the component.

getKmsKeyId

public java.lang.String getKmsKeyId()

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

setKmsKeyId

public void setKmsKeyId(java.lang.String value)

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

getSupportedOsVersions

public java.util.List<java.lang.String> getSupportedOsVersions()

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.

setSupportedOsVersions

public void setSupportedOsVersions(java.util.List<java.lang.String> value)

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.

getUri

public java.lang.String getUri()

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.

setUri

public void setUri(java.lang.String value)

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.