software.amazon.awscdk.services.imagebuilder

Class CfnComponent

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.imagebuilder.CfnComponent

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.57.0 (build f614666)",
           date="2022-04-22T22:36:22.863Z")
 @Stability(value=Stable)
public class CfnComponent
extends CfnResource
implements IInspectable

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

Components are orchestration documents that define a sequence of steps for downloading, installing, and configuring software packages or for defining tests to run on software packages. They also define validation and security hardening steps. A component is defined using a YAML document format. For more information, see Using Documents in Image Builder .

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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnComponent(software.constructs.Construct scope, 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
String	getAttrArn() Returns the Amazon Resource Name (ARN) of the component.
IResolvable	getAttrEncrypted() Returns the encryption status of the component.
String	getAttrName() Returns the name of the component.
String	getAttrType() Returns the component type.
protected Map<String,Object>	getCfnProperties()
String	getChangeDescription() A change description of the component.
String	getData() The data of the component.
String	getDescription() The description of the component.
String	getKmsKeyId() The KMS key identifier used to encrypt the component.
String	getName() The name of the component.
String	getPlatform() The platform of the component.
List<String>	getSupportedOsVersions() The operating system (OS) version supported by the component.
TagManager	getTags() The tags associated with the component.
String	getUri() The `uri` of a YAML component document file.
String	getVersion() The component version.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setChangeDescription(String value) A change description of the component.
void	setData(String value) The data of the component.
void	setDescription(String value) The description of the component.
void	setKmsKeyId(String value) The KMS key identifier used to encrypt the component.
void	setName(String value) The name of the component.
void	setPlatform(String value) The platform of the component.
void	setSupportedOsVersions(List<String> value) The operating system (OS) version supported by the component.
void	setUri(String value) The `uri` of a YAML component document file.
void	setVersion(String value) The component version.

Methods inherited from class software.amazon.awscdk.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.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnComponent(@NotNull
                                             software.constructs.Construct scope,
                                             @NotNull
                                             String id,
                                             @NotNull
                                             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

@Stability(value=Stable)
public void inspect(@NotNull
                                             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

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public 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

@Stability(value=Stable)
 @NotNull
public IResolvable getAttrEncrypted()

Returns the encryption status of the component.

For example true or false .

getAttrName

@Stability(value=Stable)
 @NotNull
public String getAttrName()

Returns the name of the component.

getAttrType

@Stability(value=Stable)
 @NotNull
public String getAttrType()

Returns the component type.

For example, BUILD or TEST .

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

The tags associated with the component.

getName

@Stability(value=Stable)
 @NotNull
public String getName()

The name of the component.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

The name of the component.

getPlatform

@Stability(value=Stable)
 @NotNull
public String getPlatform()

The platform of the component.

For example, Windows .

setPlatform

@Stability(value=Stable)
public void setPlatform(@NotNull
                                                 String value)

The platform of the component.

For example, Windows .

getVersion

@Stability(value=Stable)
 @NotNull
public String getVersion()

The component version.

For example, 1.0.0 .

setVersion

@Stability(value=Stable)
public void setVersion(@NotNull
                                                String value)

The component version.

For example, 1.0.0 .

getChangeDescription

@Stability(value=Stable)
 @Nullable
public String getChangeDescription()

A change description of the component.

For example initial version .

setChangeDescription

@Stability(value=Stable)
public void setChangeDescription(@Nullable
                                                          String value)

A change description of the component.

For example initial version .

getData

@Stability(value=Stable)
 @Nullable
public String getData()

The data of the component.

For example, name: HelloWorldTestingDocument\ndescription: This is hello world testing document.\nschemaVersion: 1.0\n\nphases:\n - name: test\n steps:\n - name: HelloWorldStep\n action: ExecuteBash\n inputs:\n commands:\n - echo \"Hello World! Test.\"\n . See Examples below for the schema for creating a component using Data.

setData

@Stability(value=Stable)
public void setData(@Nullable
                                             String value)

The data of the component.

For example, name: HelloWorldTestingDocument\ndescription: This is hello world testing document.\nschemaVersion: 1.0\n\nphases:\n - name: test\n steps:\n - name: HelloWorldStep\n action: ExecuteBash\n inputs:\n commands:\n - echo \"Hello World! Test.\"\n . See Examples below for the schema for creating a component using Data.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

The description of the component.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

The description of the component.

getKmsKeyId

@Stability(value=Stable)
 @Nullable
public String getKmsKeyId()

The KMS key identifier used to encrypt the component.

setKmsKeyId

@Stability(value=Stable)
public void setKmsKeyId(@Nullable
                                                 String value)

The KMS key identifier used to encrypt the component.

getSupportedOsVersions

@Stability(value=Stable)
 @Nullable
public List<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

@Stability(value=Stable)
public void setSupportedOsVersions(@Nullable
                                                            List<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

@Stability(value=Stable)
 @Nullable
public 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

@Stability(value=Stable)
public void setUri(@Nullable
                                            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.