CfnPublicRepositoryPropsMixin

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

Bases: Mixin

The AWS::ECR::PublicRepository resource specifies an Amazon Elastic Container Registry Public (Amazon ECR Public) repository, where users can push and pull Docker images, Open Container Initiative (OCI) images, and OCI compatible artifacts.

For more information, see Amazon ECR public repositories in the Amazon ECR Public User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html

CloudformationResource:

AWS::ECR::PublicRepository

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

# repository_catalog_data: Any
# repository_policy_text: Any

cfn_public_repository_props_mixin = ecr_mixins.CfnPublicRepositoryPropsMixin(ecr_mixins.CfnPublicRepositoryMixinProps(
    repository_catalog_data=repository_catalog_data,
    repository_name="repositoryName",
    repository_policy_text=repository_policy_text,
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

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 = ['repositoryCatalogData', 'repositoryName', 'repositoryPolicyText', 'tags']

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

RepositoryCatalogDataProperty

class CfnPublicRepositoryPropsMixin.RepositoryCatalogDataProperty(*, about_text=None, architectures=None, operating_systems=None, repository_description=None, usage_text=None)

Bases: object

The details about the repository that are publicly visible in the Amazon ECR Public Gallery.

For more information, see Amazon ECR Public repository catalog data in the Amazon ECR Public User Guide .

Parameters:
  • about_text (Optional[str]) – The longform description of the contents of the repository. This text appears in the repository details on the Amazon ECR Public Gallery.

  • architectures (Optional[Sequence[str]]) – The architecture tags that are associated with the repository.

  • operating_systems (Optional[Sequence[str]]) – The operating system tags that are associated with the repository.

  • repository_description (Optional[str]) – The short description of the repository.

  • usage_text (Optional[str]) – The longform usage details of the contents of the repository. The usage text provides context for users of the repository.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-publicrepository-repositorycatalogdata.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_catalog_data_property = ecr_mixins.CfnPublicRepositoryPropsMixin.RepositoryCatalogDataProperty(
    about_text="aboutText",
    architectures=["architectures"],
    operating_systems=["operatingSystems"],
    repository_description="repositoryDescription",
    usage_text="usageText"
)

Attributes

about_text

The longform description of the contents of the repository.

This text appears in the repository details on the Amazon ECR Public Gallery.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-publicrepository-repositorycatalogdata.html#cfn-ecr-publicrepository-repositorycatalogdata-abouttext

architectures

The architecture tags that are associated with the repository.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-publicrepository-repositorycatalogdata.html#cfn-ecr-publicrepository-repositorycatalogdata-architectures

operating_systems

The operating system tags that are associated with the repository.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-publicrepository-repositorycatalogdata.html#cfn-ecr-publicrepository-repositorycatalogdata-operatingsystems

repository_description

The short description of the repository.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-publicrepository-repositorycatalogdata.html#cfn-ecr-publicrepository-repositorycatalogdata-repositorydescription

usage_text

The longform usage details of the contents of the repository.

The usage text provides context for users of the repository.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-publicrepository-repositorycatalogdata.html#cfn-ecr-publicrepository-repositorycatalogdata-usagetext