@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)", date="2022-05-27T16:27:55.499Z") public class CfnImagePipeline extends CfnResource implements IInspectable
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();
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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
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) |
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.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnImagePipeline(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnImagePipeline(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnImagePipeline(Construct scope, java.lang.String id, CfnImagePipelineProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrArn()
For example, arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline
.
public java.lang.String getAttrName()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
public java.lang.String getInfrastructureConfigurationArn()
public void setInfrastructureConfigurationArn(java.lang.String value)
public java.lang.String getName()
public void setName(java.lang.String value)
public java.lang.String getContainerRecipeArn()
public void setContainerRecipeArn(java.lang.String value)
public java.lang.String getDescription()
public void setDescription(java.lang.String value)
public java.lang.String getDistributionConfigurationArn()
public void setDistributionConfigurationArn(java.lang.String value)
public java.lang.Object getEnhancedImageMetadataEnabled()
This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.
public void setEnhancedImageMetadataEnabled(java.lang.Boolean value)
This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.
public void setEnhancedImageMetadataEnabled(IResolvable value)
This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.
public java.lang.String getImageRecipeArn()
public void setImageRecipeArn(java.lang.String value)
public java.lang.Object getImageTestsConfiguration()
public void setImageTestsConfiguration(IResolvable value)
public void setImageTestsConfiguration(CfnImagePipeline.ImageTestsConfigurationProperty value)
public java.lang.Object getSchedule()
A schedule configures how often and when a pipeline automatically creates a new image.
public void setSchedule(IResolvable value)
A schedule configures how often and when a pipeline automatically creates a new image.
public void setSchedule(CfnImagePipeline.ScheduleProperty value)
A schedule configures how often and when a pipeline automatically creates a new image.
public java.lang.String getStatus()
public void setStatus(java.lang.String value)