Package software.amazon.awssdk.services.ecr.model

Interface CreateRepositoryCreationTemplateRequest.Builder

    • Method Detail

      • prefix

        CreateRepositoryCreationTemplateRequest.Builder prefix​(String prefix)

        The repository namespace prefix to associate with the template. All repositories created using this namespace prefix will have the settings defined in this template applied. For example, a prefix of prod would apply to all repositories beginning with prod/. Similarly, a prefix of prod/team would apply to all repositories beginning with prod/team/.

        To apply a template to all repositories in your registry that don't have an associated creation template, you can use ROOT as the prefix.

        There is always an assumed / applied to the end of the prefix. If you specify ecr-public as the prefix, Amazon ECR treats that as ecr-public/. When using a pull through cache rule, the repository prefix you specify during rule creation is what you should specify as your repository creation template prefix as well.

        Parameters:
        prefix - The repository namespace prefix to associate with the template. All repositories created using this namespace prefix will have the settings defined in this template applied. For example, a prefix of prod would apply to all repositories beginning with prod/. Similarly, a prefix of prod/team would apply to all repositories beginning with prod/team/.

        To apply a template to all repositories in your registry that don't have an associated creation template, you can use ROOT as the prefix.

        There is always an assumed / applied to the end of the prefix. If you specify ecr-public as the prefix, Amazon ECR treats that as ecr-public/. When using a pull through cache rule, the repository prefix you specify during rule creation is what you should specify as your repository creation template prefix as well.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        CreateRepositoryCreationTemplateRequest.Builder description​(String description)

        A description for the repository creation template.

        Parameters:
        description - A description for the repository creation template.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • resourceTags

        CreateRepositoryCreationTemplateRequest.Builder resourceTags​(Collection<Tag> resourceTags)

        The metadata to apply to the repository to help you categorize and organize. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

        Parameters:
        resourceTags - The metadata to apply to the repository to help you categorize and organize. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • resourceTags

        CreateRepositoryCreationTemplateRequest.Builder resourceTags​(Tag... resourceTags)

        The metadata to apply to the repository to help you categorize and organize. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

        Parameters:
        resourceTags - The metadata to apply to the repository to help you categorize and organize. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • resourceTags

        CreateRepositoryCreationTemplateRequest.Builder resourceTags​(Consumer<Tag.Builder>... resourceTags)

        The metadata to apply to the repository to help you categorize and organize. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

        This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #resourceTags(List).

        Parameters:
        resourceTags - a consumer that will call methods on Tag.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #resourceTags(java.util.Collection)

      • imageTagMutability

        CreateRepositoryCreationTemplateRequest.Builder imageTagMutability​(String imageTagMutability)

        The tag mutability setting for the repository. If this parameter is omitted, the default setting of MUTABLE will be used which will allow image tags to be overwritten. If IMMUTABLE is specified, all image tags within the repository will be immutable which will prevent them from being overwritten.

        Parameters:
        imageTagMutability - The tag mutability setting for the repository. If this parameter is omitted, the default setting of MUTABLE will be used which will allow image tags to be overwritten. If IMMUTABLE is specified, all image tags within the repository will be immutable which will prevent them from being overwritten.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ImageTagMutability, ImageTagMutability

      • imageTagMutability

        CreateRepositoryCreationTemplateRequest.Builder imageTagMutability​(ImageTagMutability imageTagMutability)

        The tag mutability setting for the repository. If this parameter is omitted, the default setting of MUTABLE will be used which will allow image tags to be overwritten. If IMMUTABLE is specified, all image tags within the repository will be immutable which will prevent them from being overwritten.

        Parameters:
        imageTagMutability - The tag mutability setting for the repository. If this parameter is omitted, the default setting of MUTABLE will be used which will allow image tags to be overwritten. If IMMUTABLE is specified, all image tags within the repository will be immutable which will prevent them from being overwritten.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ImageTagMutability, ImageTagMutability

      • repositoryPolicy

        CreateRepositoryCreationTemplateRequest.Builder repositoryPolicy​(String repositoryPolicy)

        The repository policy to apply to repositories created using the template. A repository policy is a permissions policy associated with a repository to control access permissions.

        Parameters:
        repositoryPolicy - The repository policy to apply to repositories created using the template. A repository policy is a permissions policy associated with a repository to control access permissions.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • lifecyclePolicy

        CreateRepositoryCreationTemplateRequest.Builder lifecyclePolicy​(String lifecyclePolicy)

        The lifecycle policy to use for repositories created using the template.

        Parameters:
        lifecyclePolicy - The lifecycle policy to use for repositories created using the template.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • appliedForWithStrings

        CreateRepositoryCreationTemplateRequest.Builder appliedForWithStrings​(Collection<String> appliedFor)

        A list of enumerable strings representing the Amazon ECR repository creation scenarios that this template will apply towards. The two supported scenarios are PULL_THROUGH_CACHE and REPLICATION

        Parameters:
        appliedFor - A list of enumerable strings representing the Amazon ECR repository creation scenarios that this template will apply towards. The two supported scenarios are PULL_THROUGH_CACHE and REPLICATION
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • appliedForWithStrings

        CreateRepositoryCreationTemplateRequest.Builder appliedForWithStrings​(String... appliedFor)

        A list of enumerable strings representing the Amazon ECR repository creation scenarios that this template will apply towards. The two supported scenarios are PULL_THROUGH_CACHE and REPLICATION

        Parameters:
        appliedFor - A list of enumerable strings representing the Amazon ECR repository creation scenarios that this template will apply towards. The two supported scenarios are PULL_THROUGH_CACHE and REPLICATION
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • appliedFor

        CreateRepositoryCreationTemplateRequest.Builder appliedFor​(Collection<RCTAppliedFor> appliedFor)

        A list of enumerable strings representing the Amazon ECR repository creation scenarios that this template will apply towards. The two supported scenarios are PULL_THROUGH_CACHE and REPLICATION

        Parameters:
        appliedFor - A list of enumerable strings representing the Amazon ECR repository creation scenarios that this template will apply towards. The two supported scenarios are PULL_THROUGH_CACHE and REPLICATION
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • appliedFor

        CreateRepositoryCreationTemplateRequest.Builder appliedFor​(RCTAppliedFor... appliedFor)

        A list of enumerable strings representing the Amazon ECR repository creation scenarios that this template will apply towards. The two supported scenarios are PULL_THROUGH_CACHE and REPLICATION

        Parameters:
        appliedFor - A list of enumerable strings representing the Amazon ECR repository creation scenarios that this template will apply towards. The two supported scenarios are PULL_THROUGH_CACHE and REPLICATION
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • customRoleArn

        CreateRepositoryCreationTemplateRequest.Builder customRoleArn​(String customRoleArn)

        The ARN of the role to be assumed by Amazon ECR. This role must be in the same account as the registry that you are configuring. Amazon ECR will assume your supplied role when the customRoleArn is specified. When this field isn't specified, Amazon ECR will use the service-linked role for the repository creation template.

        Parameters:
        customRoleArn - The ARN of the role to be assumed by Amazon ECR. This role must be in the same account as the registry that you are configuring. Amazon ECR will assume your supplied role when the customRoleArn is specified. When this field isn't specified, Amazon ECR will use the service-linked role for the repository creation template.
        Returns:
        Returns a reference to this object so that method calls can be chained together.