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

Class CreateRepositoryCreationTemplateRequest

    • Method Detail

      • prefix

        public final 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.

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

      • description

        public final String description()

        A description for the repository creation template.

        Returns:
        A description for the repository creation template.

      • encryptionConfiguration

        public final EncryptionConfigurationForRepositoryCreationTemplate encryptionConfiguration()

        The encryption configuration to use for repositories created using the template.

        Returns:
        The encryption configuration to use for repositories created using the template.

      • hasResourceTags

        public final boolean hasResourceTags()
        For responses, this returns true if the service returned a value for the ResourceTags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • resourceTags

        public final List<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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasResourceTags() method.

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

      • imageTagMutability

        public final 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.

        If the service returns an enum value that is not available in the current SDK version, imageTagMutability will return ImageTagMutability.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from imageTagMutabilityAsString().

        Returns:
        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.
        See Also:
        ImageTagMutability

      • imageTagMutabilityAsString

        public final String imageTagMutabilityAsString()

        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.

        If the service returns an enum value that is not available in the current SDK version, imageTagMutability will return ImageTagMutability.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from imageTagMutabilityAsString().

        Returns:
        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.
        See Also:
        ImageTagMutability

      • repositoryPolicy

        public final 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.

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

      • lifecyclePolicy

        public final String lifecyclePolicy()

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

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

      • appliedFor

        public final List<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

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAppliedFor() method.

        Returns:
        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

      • hasAppliedFor

        public final boolean hasAppliedFor()
        For responses, this returns true if the service returned a value for the AppliedFor property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • appliedForAsStrings

        public final List<String> appliedForAsStrings()

        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

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAppliedFor() method.

        Returns:
        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

      • customRoleArn

        public final 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.

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

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object