Class CreateRepositoryCreationTemplateRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.ecr.model.EcrRequest
software.amazon.awssdk.services.ecr.model.CreateRepositoryCreationTemplateRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateRepositoryCreationTemplateRequest.Builder,CreateRepositoryCreationTemplateRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateRepositoryCreationTemplateRequest extends EcrRequest implements ToCopyableBuilder<CreateRepositoryCreationTemplateRequest.Builder,CreateRepositoryCreationTemplateRequest>

  • Method Details

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

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

    • hasImageTagMutabilityExclusionFilters

      public final boolean hasImageTagMutabilityExclusionFilters()
      For responses, this returns true if the service returned a value for the ImageTagMutabilityExclusionFilters 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.

    • imageTagMutabilityExclusionFilters

      public final List<ImageTagMutabilityExclusionFilter> imageTagMutabilityExclusionFilters()

      Creates a repository creation template with a list of filters that define which image tags can override the default image tag mutability setting.

      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 hasImageTagMutabilityExclusionFilters() method.

      Returns:
      Creates a repository creation template with a list of filters that define which image tags can override the default image tag mutability setting.

    • 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.

    • toBuilder

      public CreateRepositoryCreationTemplateRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateRepositoryCreationTemplateRequest.Builder,CreateRepositoryCreationTemplateRequest>
      Specified by:
      toBuilder in class EcrRequest
      Returns:
      a builder for type T

    • builder

      public static CreateRepositoryCreationTemplateRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateRepositoryCreationTemplateRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.