CfnReplicationConfigurationPropsMixin

class aws_cdk.mixins_preview.aws_ecr.mixins.CfnReplicationConfigurationPropsMixin(props, *, strategy=None)

Bases: Mixin

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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html
CloudformationResource:: AWS::ECR::ReplicationConfiguration
Mixin:: true
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_ecr import mixins as ecr_mixins

cfn_replication_configuration_props_mixin = ecr_mixins.CfnReplicationConfigurationPropsMixin(ecr_mixins.CfnReplicationConfigurationMixinProps(
    replication_configuration=ecr_mixins.CfnReplicationConfigurationPropsMixin.ReplicationConfigurationProperty(
        rules=[ecr_mixins.CfnReplicationConfigurationPropsMixin.ReplicationRuleProperty(
            destinations=[ecr_mixins.CfnReplicationConfigurationPropsMixin.ReplicationDestinationProperty(
                region="region",
                registry_id="registryId"
            )],
            repository_filters=[ecr_mixins.CfnReplicationConfigurationPropsMixin.RepositoryFilterProperty(
                filter="filter",
                filter_type="filterType"
            )]
        )]
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::ECR::ReplicationConfiguration.

Parameters:

props (Union[CfnReplicationConfigurationMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['replicationConfiguration']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

ReplicationConfigurationProperty

class CfnReplicationConfigurationPropsMixin.ReplicationConfigurationProperty(*, rules=None)

Bases: object

The replication configuration for a registry.

Parameters:: rules (Union[IResolvable, Sequence[Union[IResolvable, ReplicationRuleProperty, Dict[str, Any]]], None]) – An array of objects representing the replication destinations and repository filters for a replication configuration.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationconfiguration.html
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.mixins_preview.aws_ecr import mixins as ecr_mixins

replication_configuration_property = ecr_mixins.CfnReplicationConfigurationPropsMixin.ReplicationConfigurationProperty(
    rules=[ecr_mixins.CfnReplicationConfigurationPropsMixin.ReplicationRuleProperty(
        destinations=[ecr_mixins.CfnReplicationConfigurationPropsMixin.ReplicationDestinationProperty(
            region="region",
            registry_id="registryId"
        )],
        repository_filters=[ecr_mixins.CfnReplicationConfigurationPropsMixin.RepositoryFilterProperty(
            filter="filter",
            filter_type="filterType"
        )]
    )]
)

Attributes

rules

An array of objects representing the replication destinations and repository filters for a replication configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationconfiguration.html#cfn-ecr-replicationconfiguration-replicationconfiguration-rules

ReplicationDestinationProperty

class CfnReplicationConfigurationPropsMixin.ReplicationDestinationProperty(*, region=None, registry_id=None)

Bases: object

An array of objects representing the destination for a replication rule.

Parameters:

region (Optional[str]) – The Region to replicate to.
registry_id (Optional[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:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationdestination.html

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.mixins_preview.aws_ecr import mixins as ecr_mixins

replication_destination_property = ecr_mixins.CfnReplicationConfigurationPropsMixin.ReplicationDestinationProperty(
    region="region",
    registry_id="registryId"
)

Attributes

region

The Region to replicate to.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationdestination.html#cfn-ecr-replicationconfiguration-replicationdestination-region

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationdestination.html#cfn-ecr-replicationconfiguration-replicationdestination-registryid

ReplicationRuleProperty

class CfnReplicationConfigurationPropsMixin.ReplicationRuleProperty(*, destinations=None, 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]]], None]) – 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:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationrule.html

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.mixins_preview.aws_ecr import mixins as ecr_mixins

replication_rule_property = ecr_mixins.CfnReplicationConfigurationPropsMixin.ReplicationRuleProperty(
    destinations=[ecr_mixins.CfnReplicationConfigurationPropsMixin.ReplicationDestinationProperty(
        region="region",
        registry_id="registryId"
    )],
    repository_filters=[ecr_mixins.CfnReplicationConfigurationPropsMixin.RepositoryFilterProperty(
        filter="filter",
        filter_type="filterType"
    )]
)

Attributes

destinations

An array of objects representing the destination for a replication rule.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationrule.html#cfn-ecr-replicationconfiguration-replicationrule-destinations

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationrule.html#cfn-ecr-replicationconfiguration-replicationrule-repositoryfilters

RepositoryFilterProperty

class CfnReplicationConfigurationPropsMixin.RepositoryFilterProperty(*, filter=None, filter_type=None)

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 (Optional[str]) – 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 (Optional[str]) – The repository filter type. The only supported value is PREFIX_MATCH , which is a repository name prefix specified with the filter parameter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-repositoryfilter.html

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.mixins_preview.aws_ecr import mixins as ecr_mixins

repository_filter_property = ecr_mixins.CfnReplicationConfigurationPropsMixin.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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-repositoryfilter.html#cfn-ecr-replicationconfiguration-repositoryfilter-filter

filter_type

The repository filter type.

The only supported value is PREFIX_MATCH , which is a repository name prefix specified with the filter parameter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-repositoryfilter.html#cfn-ecr-replicationconfiguration-repositoryfilter-filtertype