CfnImagePipeline
- class aws_cdk.aws_imagebuilder.CfnImagePipeline(scope, id, *, infrastructure_configuration_arn, name, container_recipe_arn=None, description=None, distribution_configuration_arn=None, enhanced_image_metadata_enabled=None, image_recipe_arn=None, image_scanning_configuration=None, image_tests_configuration=None, schedule=None, status=None, tags=None)
Bases:
CfnResourceA 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.
- CloudformationResource:
AWS::ImageBuilder::ImagePipeline
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_imagebuilder as imagebuilder cfn_image_pipeline = imagebuilder.CfnImagePipeline(self, "MyCfnImagePipeline", infrastructure_configuration_arn="infrastructureConfigurationArn", name="name", # the properties below are optional container_recipe_arn="containerRecipeArn", description="description", distribution_configuration_arn="distributionConfigurationArn", enhanced_image_metadata_enabled=False, image_recipe_arn="imageRecipeArn", image_scanning_configuration=imagebuilder.CfnImagePipeline.ImageScanningConfigurationProperty( ecr_configuration=imagebuilder.CfnImagePipeline.EcrConfigurationProperty( container_tags=["containerTags"], repository_name="repositoryName" ), image_scanning_enabled=False ), image_tests_configuration=imagebuilder.CfnImagePipeline.ImageTestsConfigurationProperty( image_tests_enabled=False, timeout_minutes=123 ), schedule=imagebuilder.CfnImagePipeline.ScheduleProperty( pipeline_execution_start_condition="pipelineExecutionStartCondition", schedule_expression="scheduleExpression" ), status="status", tags={ "tags_key": "tags" } )
Create a new
AWS::ImageBuilder::ImagePipeline.- Parameters:
scope (
Construct) –scope in which this resource is defined.
id (
str) –scoped id of the resource.
infrastructure_configuration_arn (
str) – The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.name (
str) – The name of the image pipeline.container_recipe_arn (
Optional[str]) – The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.description (
Optional[str]) – The description of this image pipeline.distribution_configuration_arn (
Optional[str]) – The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.enhanced_image_metadata_enabled (
Union[bool,IResolvable,None]) – 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.image_recipe_arn (
Optional[str]) – The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.image_scanning_configuration (
Union[IResolvable,ImageScanningConfigurationProperty,Dict[str,Any],None]) –AWS::ImageBuilder::ImagePipeline.ImageScanningConfiguration.image_tests_configuration (
Union[IResolvable,ImageTestsConfigurationProperty,Dict[str,Any],None]) – The configuration of the image tests that run after image creation to ensure the quality of the image that was created.schedule (
Union[IResolvable,ScheduleProperty,Dict[str,Any],None]) – The schedule of the image pipeline. A schedule configures how often and when a pipeline automatically creates a new image.status (
Optional[str]) – The status of the image pipeline.tags (
Optional[Mapping[str,str]]) – The tags of this image pipeline.
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined).- Parameters:
path (
str) – The path of the value to delete.- Return type:
None
- add_depends_on(target)
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters:
target (
CfnResource) –- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str) –value (
Any) –
- See:
- Return type:
None
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverrideor prefixpathwith “Properties.” (i.e.Properties.TopicName).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.in the property name, prefix with a\. In most programming languages you will need to write this as"\\."because the\itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
valueargument toaddOverridewill not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters:
path (
str) –The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (
Any) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value).- Parameters:
property_path (
str) – The path of the property.value (
Any) – The value.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).- Parameters:
policy (
Optional[RemovalPolicy]) –apply_to_update_replace_policy (
Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.
- Return type:
None
- get_att(attribute_name)
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn), but this can be used for future compatibility in case there is no generated attribute.- Parameters:
attribute_name (
str) – The name of the attribute.- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str) –- See:
- Return type:
Any
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector) –tree inspector to collect and process attributes.
- Return type:
None
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str) – The new logical ID to use for this stack element.- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str- Returns:
a string representation of this resource
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::ImageBuilder::ImagePipeline'
- attr_arn
Returns the Amazon Resource Name (ARN) of the image pipeline.
For example,
arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline.- CloudformationAttribute:
Arn
- attr_name
Returns the name of the image pipeline.
- CloudformationAttribute:
Name
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- container_recipe_arn
The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- description
The description of this image pipeline.
- distribution_configuration_arn
The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
- enhanced_image_metadata_enabled
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.
- image_recipe_arn
The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.
- image_scanning_configuration
AWS::ImageBuilder::ImagePipeline.ImageScanningConfiguration.
- image_tests_configuration
The configuration of the image tests that run after image creation to ensure the quality of the image that was created.
- infrastructure_configuration_arn
The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
- logical_id
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId).- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- name
The name of the image pipeline.
- node
The construct tree node associated with this construct.
- ref
Return a string that will be resolved to a CloudFormation
{ Ref }for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref }).
- schedule
The schedule of the image pipeline.
A schedule configures how often and when a pipeline automatically creates a new image.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- status
The status of the image pipeline.
- tags
The tags of this image pipeline.
Static Methods
- classmethod is_cfn_element(x)
Returns
trueif a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceofto allow stack elements from different versions of this library to be included in the same stack.- Parameters:
x (
Any) –- Return type:
bool- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_resource(construct)
Check whether the given construct is a CfnResource.
- Parameters:
construct (
IConstruct) –- Return type:
bool
- classmethod is_construct(x)
Return whether the given object is a Construct.
- Parameters:
x (
Any) –- Return type:
bool
EcrConfigurationProperty
- class CfnImagePipeline.EcrConfigurationProperty(*, container_tags=None, repository_name=None)
Bases:
object- Parameters:
container_tags (
Optional[Sequence[str]]) –CfnImagePipeline.EcrConfigurationProperty.ContainerTags.repository_name (
Optional[str]) –CfnImagePipeline.EcrConfigurationProperty.RepositoryName.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_imagebuilder as imagebuilder ecr_configuration_property = imagebuilder.CfnImagePipeline.EcrConfigurationProperty( container_tags=["containerTags"], repository_name="repositoryName" )
Attributes
- container_tags
CfnImagePipeline.EcrConfigurationProperty.ContainerTags.
- repository_name
CfnImagePipeline.EcrConfigurationProperty.RepositoryName.
ImageScanningConfigurationProperty
- class CfnImagePipeline.ImageScanningConfigurationProperty(*, ecr_configuration=None, image_scanning_enabled=None)
Bases:
object- Parameters:
ecr_configuration (
Union[IResolvable,EcrConfigurationProperty,Dict[str,Any],None]) –CfnImagePipeline.ImageScanningConfigurationProperty.EcrConfiguration.image_scanning_enabled (
Union[bool,IResolvable,None]) –CfnImagePipeline.ImageScanningConfigurationProperty.ImageScanningEnabled.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_imagebuilder as imagebuilder image_scanning_configuration_property = imagebuilder.CfnImagePipeline.ImageScanningConfigurationProperty( ecr_configuration=imagebuilder.CfnImagePipeline.EcrConfigurationProperty( container_tags=["containerTags"], repository_name="repositoryName" ), image_scanning_enabled=False )
Attributes
- ecr_configuration
CfnImagePipeline.ImageScanningConfigurationProperty.EcrConfiguration.
- image_scanning_enabled
CfnImagePipeline.ImageScanningConfigurationProperty.ImageScanningEnabled.
ImageTestsConfigurationProperty
- class CfnImagePipeline.ImageTestsConfigurationProperty(*, image_tests_enabled=None, timeout_minutes=None)
Bases:
objectWhen 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.
You must have at least one build component to create a recipe, but test components are not required. Your pipeline runs tests after it builds the image, to ensure that the target image is functional and can be used reliably for launching Amazon EC2 instances.
- Parameters:
image_tests_enabled (
Union[bool,IResolvable,None]) – Defines if tests should be executed when building this image. For example,trueorfalse.timeout_minutes (
Union[int,float,None]) – The maximum time in minutes that tests are permitted to run. .. epigraph:: The timeoutMinutes attribute is not currently active. This value is ignored.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_imagebuilder as imagebuilder image_tests_configuration_property = imagebuilder.CfnImagePipeline.ImageTestsConfigurationProperty( image_tests_enabled=False, timeout_minutes=123 )
Attributes
- image_tests_enabled
Defines if tests should be executed when building this image.
For example,
trueorfalse.
- timeout_minutes
The maximum time in minutes that tests are permitted to run.
The timeoutMinutes attribute is not currently active. This value is ignored.
ScheduleProperty
- class CfnImagePipeline.ScheduleProperty(*, pipeline_execution_start_condition=None, schedule_expression=None)
Bases:
objectA schedule configures how often and when a pipeline will automatically create a new image.
- Parameters:
pipeline_execution_start_condition (
Optional[str]) – The condition configures when the pipeline should trigger a new image build. When thepipelineExecutionStartConditionis set toEXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE, and you use semantic version filters on the base image or components in your image recipe, Image Builder will build a new image only when there are new versions of the image or components in your recipe that match the semantic version filter. When it is set toEXPRESSION_MATCH_ONLY, it will build a new image every time the CRON expression matches the current time. For semantic version syntax, see CreateComponent in the Image Builder API Reference .schedule_expression (
Optional[str]) – The cron expression determines how often EC2 Image Builder evaluates yourpipelineExecutionStartCondition. For information on how to format a cron expression in Image Builder, see Use cron expressions in EC2 Image Builder .
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_imagebuilder as imagebuilder schedule_property = imagebuilder.CfnImagePipeline.ScheduleProperty( pipeline_execution_start_condition="pipelineExecutionStartCondition", schedule_expression="scheduleExpression" )
Attributes
- pipeline_execution_start_condition
The condition configures when the pipeline should trigger a new image build.
When the
pipelineExecutionStartConditionis set toEXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE, and you use semantic version filters on the base image or components in your image recipe, Image Builder will build a new image only when there are new versions of the image or components in your recipe that match the semantic version filter. When it is set toEXPRESSION_MATCH_ONLY, it will build a new image every time the CRON expression matches the current time. For semantic version syntax, see CreateComponent in the Image Builder API Reference .
- schedule_expression
The cron expression determines how often EC2 Image Builder evaluates your
pipelineExecutionStartCondition.For information on how to format a cron expression in Image Builder, see Use cron expressions in EC2 Image Builder .