CfnReplicationConfiguration
- class aws_cdk.aws_ecr.CfnReplicationConfiguration(scope, id, *, replication_configuration)
Bases:
CfnResource
The
AWS::ECR::ReplicationConfiguration
resource creates or updates the replication configuration for a private registry.The first time a replication configuration is applied to a private registry, a service-linked IAM role is created in your account for the replication process. For more information, see Using Service-Linked Roles for Amazon ECR in the Amazon Elastic Container Registry User Guide . .. epigraph:
When configuring cross-account replication, the destination account must grant the source account permission to replicate. This permission is controlled using a private registry permissions policy. For more information, see ``AWS::ECR::RegistryPolicy`` .
- See:
- CloudformationResource:
AWS::ECR::ReplicationConfiguration
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_ecr as ecr cfn_replication_configuration = ecr.CfnReplicationConfiguration(self, "MyCfnReplicationConfiguration", replication_configuration=ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty( rules=[ecr.CfnReplicationConfiguration.ReplicationRuleProperty( destinations=[ecr.CfnReplicationConfiguration.ReplicationDestinationProperty( region="region", registry_id="registryId" )], # the properties below are optional repository_filters=[ecr.CfnReplicationConfiguration.RepositoryFilterProperty( filter="filter", filter_type="filterType" )] )] ) )
- Parameters:
scope (
Construct
) – Scope in which this resource is defined.id (
str
) – Construct identifier for this resource (unique in its scope).replication_configuration (
Union
[IResolvable
,ReplicationConfigurationProperty
,Dict
[str
,Any
]]) – The replication configuration for a registry.
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_dependency(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_depends_on(target)
(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
- Parameters:
target (
CfnResource
) –- Deprecated:
use addDependency
- Stability:
deprecated
- 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
addPropertyOverride
or prefixpath
with “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
value
argument toaddOverride
will 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 intermediate 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
). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT
). A list of resources that support this policy can be found in the following link:- 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 resource, please consult that specific resource’s documentation.
- See:
- Return type:
None
- get_att(attribute_name, type_hint=None)
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.type_hint (
Optional
[ResolutionTypeHint
]) –
- 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
- obtain_dependencies()
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
- Return type:
List
[Union
[Stack
,CfnResource
]]
- obtain_resource_dependencies()
Get a shallow copy of dependencies between this resource and other resources in the same stack.
- Return type:
List
[CfnResource
]
- 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
- remove_dependency(target)
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
- Parameters:
target (
CfnResource
) –- Return type:
None
- replace_dependency(target, new_target)
Replaces one dependency with another.
- Parameters:
target (
CfnResource
) – The dependency to replace.new_target (
CfnResource
) – The new dependency to add.
- 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::ECR::ReplicationConfiguration'
- attr_registry_id
The account ID of the destination registry.
- CloudformationAttribute:
RegistryId
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- 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.
- 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 tree node.
- 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 })
.
- replication_configuration
The replication configuration for a registry.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
Static Methods
- classmethod is_cfn_element(x)
Returns
true
if a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceof
to 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(x)
Check whether the given object is a CfnResource.
- Parameters:
x (
Any
) –- Return type:
bool
- classmethod is_construct(x)
Checks if
x
is a construct.Use this method instead of
instanceof
to properly detectConstruct
instances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
constructs
library on disk are seen as independent, completely different libraries. As a consequence, the classConstruct
in each copy of theconstructs
library is seen as a different class, and an instance of one class will not test asinstanceof
the other class.npm install
will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of theconstructs
library can be accidentally installed, andinstanceof
will behave unpredictably. It is safest to avoid usinginstanceof
, and using this type-testing method instead.- Parameters:
x (
Any
) – Any object.- Return type:
bool
- Returns:
true if
x
is an object created from a class which extendsConstruct
.
ReplicationConfigurationProperty
- class CfnReplicationConfiguration.ReplicationConfigurationProperty(*, rules)
Bases:
object
The replication configuration for a registry.
- Parameters:
rules (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,ReplicationRuleProperty
,Dict
[str
,Any
]]]]) – An array of objects representing the replication destinations and repository filters for a replication configuration.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_ecr as ecr replication_configuration_property = ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty( rules=[ecr.CfnReplicationConfiguration.ReplicationRuleProperty( destinations=[ecr.CfnReplicationConfiguration.ReplicationDestinationProperty( region="region", registry_id="registryId" )], # the properties below are optional repository_filters=[ecr.CfnReplicationConfiguration.RepositoryFilterProperty( filter="filter", filter_type="filterType" )] )] )
Attributes
- rules
An array of objects representing the replication destinations and repository filters for a replication configuration.
ReplicationDestinationProperty
- class CfnReplicationConfiguration.ReplicationDestinationProperty(*, region, registry_id)
Bases:
object
An array of objects representing the destination for a replication rule.
- Parameters:
region (
str
) – The Region to replicate to.registry_id (
str
) – The AWS account ID of the Amazon ECR private registry to replicate to. When configuring cross-Region replication within your own registry, specify your own account ID.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_ecr as ecr replication_destination_property = ecr.CfnReplicationConfiguration.ReplicationDestinationProperty( region="region", registry_id="registryId" )
Attributes
- region
The Region to replicate to.
- registry_id
The AWS account ID of the Amazon ECR private registry to replicate to.
When configuring cross-Region replication within your own registry, specify your own account ID.
ReplicationRuleProperty
- class CfnReplicationConfiguration.ReplicationRuleProperty(*, destinations, repository_filters=None)
Bases:
object
An array of objects representing the replication destinations and repository filters for a replication configuration.
- Parameters:
destinations (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,ReplicationDestinationProperty
,Dict
[str
,Any
]]]]) – An array of objects representing the destination for a replication rule.repository_filters (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,RepositoryFilterProperty
,Dict
[str
,Any
]]],None
]) – An array of objects representing the filters for a replication rule. Specifying a repository filter for a replication rule provides a method for controlling which repositories in a private registry are replicated.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_ecr as ecr replication_rule_property = ecr.CfnReplicationConfiguration.ReplicationRuleProperty( destinations=[ecr.CfnReplicationConfiguration.ReplicationDestinationProperty( region="region", registry_id="registryId" )], # the properties below are optional repository_filters=[ecr.CfnReplicationConfiguration.RepositoryFilterProperty( filter="filter", filter_type="filterType" )] )
Attributes
- destinations
An array of objects representing the destination for a replication rule.
- repository_filters
An array of objects representing the filters for a replication rule.
Specifying a repository filter for a replication rule provides a method for controlling which repositories in a private registry are replicated.
RepositoryFilterProperty
- class CfnReplicationConfiguration.RepositoryFilterProperty(*, filter, filter_type)
Bases:
object
The filter settings used with image replication.
Specifying a repository filter to a replication rule provides a method for controlling which repositories in a private registry are replicated. If no filters are added, the contents of all repositories are replicated.
- Parameters:
filter (
str
) – The repository filter details. When thePREFIX_MATCH
filter type is specified, this value is required and should be the repository name prefix to configure replication for.filter_type (
str
) – The repository filter type. The only supported value isPREFIX_MATCH
, which is a repository name prefix specified with thefilter
parameter.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_ecr as ecr repository_filter_property = ecr.CfnReplicationConfiguration.RepositoryFilterProperty( filter="filter", filter_type="filterType" )
Attributes
- filter
The repository filter details.
When the
PREFIX_MATCH
filter type is specified, this value is required and should be the repository name prefix to configure replication for.
- filter_type
The repository filter type.
The only supported value is
PREFIX_MATCH
, which is a repository name prefix specified with thefilter
parameter.