Package software.amazon.awscdk.services.ecr

Class CfnReplicationConfiguration

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.ecr.CfnReplicationConfiguration
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:37.413Z") @Stability(Stable) public class CfnReplicationConfiguration extends CfnResource implements IInspectable
A CloudFormation AWS::ECR::ReplicationConfiguration.

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 .

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 .

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.ecr.*;
 CfnReplicationConfiguration cfnReplicationConfiguration = CfnReplicationConfiguration.Builder.create(this, "MyCfnReplicationConfiguration")
         .replicationConfiguration(ReplicationConfigurationProperty.builder()
                 .rules(List.of(ReplicationRuleProperty.builder()
                         .destinations(List.of(ReplicationDestinationProperty.builder()
                                 .region("region")
                                 .registryId("registryId")
                                 .build()))
                         // the properties below are optional
                         .repositoryFilters(List.of(RepositoryFilterProperty.builder()
                                 .filter("filter")
                                 .filterType("filterType")
                                 .build()))
                         .build()))
                 .build())
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnReplicationConfiguration

      protected CfnReplicationConfiguration(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnReplicationConfiguration

      protected CfnReplicationConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnReplicationConfiguration

      @Stability(Stable) public CfnReplicationConfiguration(@NotNull Construct scope, @NotNull String id, @NotNull CfnReplicationConfigurationProps props)
      Create a new AWS::ECR::ReplicationConfiguration.

      Parameters:
      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.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrRegistryId

      @Stability(Stable) @NotNull public String getAttrRegistryId()
      The account ID of the destination registry.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getReplicationConfiguration

      @Stability(Stable) @NotNull public Object getReplicationConfiguration()
      The replication configuration for a registry.

    • setReplicationConfiguration

      @Stability(Stable) public void setReplicationConfiguration(@NotNull IResolvable value)
      The replication configuration for a registry.

    • setReplicationConfiguration

      @Stability(Stable) public void setReplicationConfiguration(@NotNull CfnReplicationConfiguration.ReplicationConfigurationProperty value)
      The replication configuration for a registry.