software.amazon.awscdk.services.imagebuilder

Class CfnImagePipeline

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.CfnImagePipeline

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-28T18:14:33.583Z")
public class CfnImagePipeline
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ImageBuilder::ImagePipeline`.

An image pipeline is the automation configuration for building secure OS images on AWS . The Image Builder image pipeline is associated with an image recipe that defines the build, validation, and test phases for an image build lifecycle. An image pipeline can be associated with an infrastructure configuration that defines where your image is built. You can define attributes, such as instance type, subnets, security groups, logging, and other infrastructure-related configurations. You can also associate your image pipeline with a distribution configuration to define how you would like to deploy your image.

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.*;
 CfnImagePipeline cfnImagePipeline = CfnImagePipeline.Builder.create(this, "MyCfnImagePipeline")
         .infrastructureConfigurationArn("infrastructureConfigurationArn")
         .name("name")
         // the properties below are optional
         .containerRecipeArn("containerRecipeArn")
         .description("description")
         .distributionConfigurationArn("distributionConfigurationArn")
         .enhancedImageMetadataEnabled(false)
         .imageRecipeArn("imageRecipeArn")
         .imageTestsConfiguration(ImageTestsConfigurationProperty.builder()
                 .imageTestsEnabled(false)
                 .timeoutMinutes(123)
                 .build())
         .schedule(ScheduleProperty.builder()
                 .pipelineExecutionStartCondition("pipelineExecutionStartCondition")
                 .scheduleExpression("scheduleExpression")
                 .build())
         .status("status")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnImagePipeline.Builder A fluent builder for CfnImagePipeline.
static interface	CfnImagePipeline.ImageTestsConfigurationProperty When you create an image or container recipe with Image Builder , you can add the build or test components that your image pipeline uses to create the final image.
static interface	CfnImagePipeline.ScheduleProperty A schedule configures how often and when a pipeline will automatically create a new image.

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
	CfnImagePipeline(Construct scope, java.lang.String id, CfnImagePipelineProps props) Create a new `AWS::ImageBuilder::ImagePipeline`.
protected	CfnImagePipeline(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnImagePipeline(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 image pipeline.
java.lang.String	getAttrName() Returns the name of the image pipeline.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getContainerRecipeArn() The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.
java.lang.String	getDescription() The description of this image pipeline.
java.lang.String	getDistributionConfigurationArn() The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
java.lang.Object	getEnhancedImageMetadataEnabled() Collects additional information about the image being created, including the operating system (OS) version and package list.
java.lang.String	getImageRecipeArn() The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.
java.lang.Object	getImageTestsConfiguration() The configuration of the image tests that run after image creation to ensure the quality of the image that was created.
java.lang.String	getInfrastructureConfigurationArn() The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
java.lang.String	getName() The name of the image pipeline.
java.lang.Object	getSchedule() The schedule of the image pipeline.
java.lang.String	getStatus() The status of the image pipeline.
TagManager	getTags() The tags of this image pipeline.
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	setContainerRecipeArn(java.lang.String value) The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.
void	setDescription(java.lang.String value) The description of this image pipeline.
void	setDistributionConfigurationArn(java.lang.String value) The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
void	setEnhancedImageMetadataEnabled(java.lang.Boolean value) Collects additional information about the image being created, including the operating system (OS) version and package list.
void	setEnhancedImageMetadataEnabled(IResolvable value) Collects additional information about the image being created, including the operating system (OS) version and package list.
void	setImageRecipeArn(java.lang.String value) The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.
void	setImageTestsConfiguration(CfnImagePipeline.ImageTestsConfigurationProperty value) The configuration of the image tests that run after image creation to ensure the quality of the image that was created.
void	setImageTestsConfiguration(IResolvable value) The configuration of the image tests that run after image creation to ensure the quality of the image that was created.
void	setInfrastructureConfigurationArn(java.lang.String value) The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
void	setName(java.lang.String value) The name of the image pipeline.
void	setSchedule(CfnImagePipeline.ScheduleProperty value) The schedule of the image pipeline.
void	setSchedule(IResolvable value) The schedule of the image pipeline.
void	setStatus(java.lang.String value) The status of the image pipeline.

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

CfnImagePipeline

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

CfnImagePipeline

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

CfnImagePipeline

public CfnImagePipeline(Construct scope,
                        java.lang.String id,
                        CfnImagePipelineProps props)

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

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 image pipeline.

For example, arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline .

getAttrName

public java.lang.String getAttrName()

Returns the name of the image pipeline.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

The tags of this image pipeline.

getInfrastructureConfigurationArn

public java.lang.String getInfrastructureConfigurationArn()

The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.

setInfrastructureConfigurationArn

public void setInfrastructureConfigurationArn(java.lang.String value)

The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.

getName

public java.lang.String getName()

The name of the image pipeline.

setName

public void setName(java.lang.String value)

The name of the image pipeline.

getContainerRecipeArn

public java.lang.String getContainerRecipeArn()

The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.

setContainerRecipeArn

public void setContainerRecipeArn(java.lang.String value)

The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.

getDescription

public java.lang.String getDescription()

The description of this image pipeline.

setDescription

public void setDescription(java.lang.String value)

The description of this image pipeline.

getDistributionConfigurationArn

public java.lang.String getDistributionConfigurationArn()

The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.

setDistributionConfigurationArn

public void setDistributionConfigurationArn(java.lang.String value)

The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.

getEnhancedImageMetadataEnabled

public java.lang.Object getEnhancedImageMetadataEnabled()

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.

setEnhancedImageMetadataEnabled

public void setEnhancedImageMetadataEnabled(java.lang.Boolean value)

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.

setEnhancedImageMetadataEnabled

public void setEnhancedImageMetadataEnabled(IResolvable value)

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.

getImageRecipeArn

public java.lang.String getImageRecipeArn()

The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.

setImageRecipeArn

public void setImageRecipeArn(java.lang.String value)

The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.

getImageTestsConfiguration

public java.lang.Object getImageTestsConfiguration()

The configuration of the image tests that run after image creation to ensure the quality of the image that was created.

setImageTestsConfiguration

public void setImageTestsConfiguration(IResolvable value)

The configuration of the image tests that run after image creation to ensure the quality of the image that was created.

setImageTestsConfiguration

public void setImageTestsConfiguration(CfnImagePipeline.ImageTestsConfigurationProperty value)

The configuration of the image tests that run after image creation to ensure the quality of the image that was created.

getSchedule

public java.lang.Object getSchedule()

The schedule of the image pipeline.

A schedule configures how often and when a pipeline automatically creates a new image.

setSchedule

public void setSchedule(IResolvable value)

The schedule of the image pipeline.

A schedule configures how often and when a pipeline automatically creates a new image.

setSchedule

public void setSchedule(CfnImagePipeline.ScheduleProperty value)

The schedule of the image pipeline.

A schedule configures how often and when a pipeline automatically creates a new image.

getStatus

public java.lang.String getStatus()

The status of the image pipeline.

setStatus

public void setStatus(java.lang.String value)

The status of the image pipeline.