software.amazon.awscdk.services.imagebuilder

Class CfnImagePipeline

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

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.818Z")
 @Stability(value=Stable)
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 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
	CfnImagePipeline(software.constructs.Construct scope, 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
String	getAttrArn() Returns the Amazon Resource Name (ARN) of the image pipeline.
String	getAttrName() Returns the name of the image pipeline.
protected Map<String,Object>	getCfnProperties()
String	getContainerRecipeArn() The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.
String	getDescription() The description of this image pipeline.
String	getDistributionConfigurationArn() The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
Object	getEnhancedImageMetadataEnabled() Collects additional information about the image being created, including the operating system (OS) version and package list.
String	getImageRecipeArn() The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.
Object	getImageTestsConfiguration() The configuration of the image tests that run after image creation to ensure the quality of the image that was created.
String	getInfrastructureConfigurationArn() The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
String	getName() The name of the image pipeline.
Object	getSchedule() The schedule of the image pipeline.
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 Map<String,Object>	renderProperties(Map<String,Object> props)
void	setContainerRecipeArn(String value) The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.
void	setDescription(String value) The description of this image pipeline.
void	setDistributionConfigurationArn(String value) The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
void	setEnhancedImageMetadataEnabled(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(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(String value) The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
void	setName(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(String value) The status of the image pipeline.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, 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

CfnImagePipeline

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

CfnImagePipeline

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

CfnImagePipeline

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

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

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

getAttrName

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

Returns the name of the image pipeline.

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

getInfrastructureConfigurationArn

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

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

setInfrastructureConfigurationArn

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

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

getName

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

The name of the image pipeline.

setName

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

The name of the image pipeline.

getContainerRecipeArn

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

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

setContainerRecipeArn

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

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

getDescription

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

The description of this image pipeline.

setDescription

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

The description of this image pipeline.

getDistributionConfigurationArn

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

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

setDistributionConfigurationArn

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

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

getEnhancedImageMetadataEnabled

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

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

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

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

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

setImageRecipeArn

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

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

getImageTestsConfiguration

@Stability(value=Stable)
 @Nullable
public Object getImageTestsConfiguration()

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

setImageTestsConfiguration

@Stability(value=Stable)
public void setImageTestsConfiguration(@Nullable
                                                                CfnImagePipeline.ImageTestsConfigurationProperty value)

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

setImageTestsConfiguration

@Stability(value=Stable)
public void setImageTestsConfiguration(@Nullable
                                                                IResolvable value)

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

getSchedule

@Stability(value=Stable)
 @Nullable
public Object getSchedule()

The schedule of the image pipeline.

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

setSchedule

@Stability(value=Stable)
public void setSchedule(@Nullable
                                                 CfnImagePipeline.ScheduleProperty value)

The schedule of the image pipeline.

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

setSchedule

@Stability(value=Stable)
public void setSchedule(@Nullable
                                                 IResolvable value)

The schedule of the image pipeline.

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

getStatus

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

The status of the image pipeline.

setStatus

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

The status of the image pipeline.