CfnImage
- class aws_cdk.aws_imagebuilder.CfnImage(scope, id, *, infrastructure_configuration_arn, container_recipe_arn=None, distribution_configuration_arn=None, enhanced_image_metadata_enabled=None, image_recipe_arn=None, image_scanning_configuration=None, image_tests_configuration=None, tags=None)
Bases:
CfnResourceA CloudFormation
AWS::ImageBuilder::Image.An image build version. An image is a customized, secure, and up-to-date “golden” server image that is pre-installed and pre-configured with software and settings to meet specific IT standards.
- CloudformationResource:
AWS::ImageBuilder::Image
- Link:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.html
- 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 = imagebuilder.CfnImage(self, "MyCfnImage", infrastructure_configuration_arn="infrastructureConfigurationArn", # the properties below are optional container_recipe_arn="containerRecipeArn", distribution_configuration_arn="distributionConfigurationArn", enhanced_image_metadata_enabled=False, image_recipe_arn="imageRecipeArn", image_scanning_configuration=imagebuilder.CfnImage.ImageScanningConfigurationProperty( ecr_configuration=imagebuilder.CfnImage.EcrConfigurationProperty( container_tags=["containerTags"], repository_name="repositoryName" ), image_scanning_enabled=False ), image_tests_configuration=imagebuilder.CfnImage.ImageTestsConfigurationProperty( image_tests_enabled=False, timeout_minutes=123 ), tags={ "tags_key": "tags" } )
Create a new
AWS::ImageBuilder::Image.- 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.container_recipe_arn (
Optional[str]) – The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.distribution_configuration_arn (
Optional[str]) – The Amazon Resource Name (ARN) of the distribution configuration.enhanced_image_metadata_enabled (
Union[bool,IResolvable,None]) – Indicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list.image_recipe_arn (
Optional[str]) – The Amazon Resource Name (ARN) of the image recipe.image_scanning_configuration (
Union[IResolvable,ImageScanningConfigurationProperty,Dict[str,Any],None]) –AWS::ImageBuilder::Image.ImageScanningConfiguration.image_tests_configuration (
Union[IResolvable,ImageTestsConfigurationProperty,Dict[str,Any],None]) – The configuration settings for your image test components, which includes a toggle that allows you to turn off tests, and a timeout setting.tags (
Optional[Mapping[str,str]]) – The tags of the image.
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::Image'
- attr_arn
Returns the Amazon Resource Name (ARN) of the image.
For example,
arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/1.- CloudformationAttribute:
Arn
- attr_image_id
Returns the AMI ID of the Amazon EC2 AMI in the Region in which you are using Image Builder.
Values are returned only for AMIs, and not for container images.
- CloudformationAttribute:
ImageId
- attr_image_uri
Returns a list of URIs for container images created in the context Region.
Values are returned only for container images, and not for AMIs.
- CloudformationAttribute:
ImageUri
- attr_name
Returns the name of the image.
- 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.
- distribution_configuration_arn
The Amazon Resource Name (ARN) of the distribution configuration.
- enhanced_image_metadata_enabled
Indicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list.
- image_recipe_arn
The Amazon Resource Name (ARN) of the image recipe.
- image_scanning_configuration
AWS::ImageBuilder::Image.ImageScanningConfiguration.
- image_tests_configuration
The configuration settings for your image test components, which includes a toggle that allows you to turn off tests, and a timeout setting.
- 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.
- 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 }).
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- tags
The tags of the image.
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 CfnImage.EcrConfigurationProperty(*, container_tags=None, repository_name=None)
Bases:
object- Parameters:
container_tags (
Optional[Sequence[str]]) –CfnImage.EcrConfigurationProperty.ContainerTags.repository_name (
Optional[str]) –CfnImage.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.CfnImage.EcrConfigurationProperty( container_tags=["containerTags"], repository_name="repositoryName" )
Attributes
- container_tags
CfnImage.EcrConfigurationProperty.ContainerTags.
- repository_name
CfnImage.EcrConfigurationProperty.RepositoryName.
ImageScanningConfigurationProperty
- class CfnImage.ImageScanningConfigurationProperty(*, ecr_configuration=None, image_scanning_enabled=None)
Bases:
object- Parameters:
ecr_configuration (
Union[IResolvable,EcrConfigurationProperty,Dict[str,Any],None]) –CfnImage.ImageScanningConfigurationProperty.EcrConfiguration.image_scanning_enabled (
Union[bool,IResolvable,None]) –CfnImage.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.CfnImage.ImageScanningConfigurationProperty( ecr_configuration=imagebuilder.CfnImage.EcrConfigurationProperty( container_tags=["containerTags"], repository_name="repositoryName" ), image_scanning_enabled=False )
Attributes
- ecr_configuration
CfnImage.ImageScanningConfigurationProperty.EcrConfiguration.
- image_scanning_enabled
CfnImage.ImageScanningConfigurationProperty.ImageScanningEnabled.
ImageTestsConfigurationProperty
- class CfnImage.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 are used to create the final image.
You must have at least one build component to create a recipe, but test components are not required. If you have added tests, they run after the image is created, 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]) – Determines if tests should run after building the image. Image Builder defaults to enable tests to run following the image build, before image distribution.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.CfnImage.ImageTestsConfigurationProperty( image_tests_enabled=False, timeout_minutes=123 )
Attributes
- image_tests_enabled
Determines if tests should run after building the image.
Image Builder defaults to enable tests to run following the image build, before image distribution.
- timeout_minutes
The maximum time in minutes that tests are permitted to run.
The timeoutMinutes attribute is not currently active. This value is ignored.