Interface CreatePullThroughCacheRuleRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreatePullThroughCacheRuleRequest.Builder,CreatePullThroughCacheRuleRequest>, EcrRequest.Builder, SdkBuilder<CreatePullThroughCacheRuleRequest.Builder,CreatePullThroughCacheRuleRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreatePullThroughCacheRuleRequest
@Mutable @NotThreadSafe public static interface CreatePullThroughCacheRuleRequest.Builder extends EcrRequest.Builder, SdkPojo, CopyableBuilder<CreatePullThroughCacheRuleRequest.Builder,CreatePullThroughCacheRuleRequest>

  • Method Details

    • ecrRepositoryPrefix

      CreatePullThroughCacheRuleRequest.Builder ecrRepositoryPrefix(String ecrRepositoryPrefix)

      The repository name prefix to use when caching images from the source registry.

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

      Parameters:
      ecrRepositoryPrefix - The repository name prefix to use when caching images from the source registry.

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

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

    • upstreamRegistryUrl

      CreatePullThroughCacheRuleRequest.Builder upstreamRegistryUrl(String upstreamRegistryUrl)

      The registry URL of the upstream public registry to use as the source for the pull through cache rule. The following is the syntax to use for each supported upstream registry.

      • Amazon ECR (ecr) – <accountId>.dkr.ecr.<region>.amazonaws.com

      • Amazon ECR Public (ecr-public) – public.ecr.aws

      • Docker Hub (docker-hub) – registry-1.docker.io

      • GitHub Container Registry (github-container-registry) – ghcr.io

      • GitLab Container Registry (gitlab-container-registry) – registry.gitlab.com

      • Kubernetes (k8s) – registry.k8s.io

      • Microsoft Azure Container Registry (azure-container-registry) – <custom>.azurecr.io

      • Quay (quay) – quay.io

      Parameters:
      upstreamRegistryUrl - The registry URL of the upstream public registry to use as the source for the pull through cache rule. The following is the syntax to use for each supported upstream registry.

      • Amazon ECR (ecr) – <accountId>.dkr.ecr.<region>.amazonaws.com

      • Amazon ECR Public (ecr-public) – public.ecr.aws

      • Docker Hub (docker-hub) – registry-1.docker.io

      • GitHub Container Registry (github-container-registry) – ghcr.io

      • GitLab Container Registry (gitlab-container-registry) – registry.gitlab.com

      • Kubernetes (k8s) – registry.k8s.io

      • Microsoft Azure Container Registry (azure-container-registry) – <custom>.azurecr.io

      • Quay (quay) – quay.io

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

    • registryId

      CreatePullThroughCacheRuleRequest.Builder registryId(String registryId)

      The Amazon Web Services account ID associated with the registry to create the pull through cache rule for. If you do not specify a registry, the default registry is assumed.

      Parameters:
      registryId - The Amazon Web Services account ID associated with the registry to create the pull through cache rule for. If you do not specify a registry, the default registry is assumed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • upstreamRegistry

      CreatePullThroughCacheRuleRequest.Builder upstreamRegistry(String upstreamRegistry)

      The name of the upstream registry.

      Parameters:
      upstreamRegistry - The name of the upstream registry.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • upstreamRegistry

      CreatePullThroughCacheRuleRequest.Builder upstreamRegistry(UpstreamRegistry upstreamRegistry)

      The name of the upstream registry.

      Parameters:
      upstreamRegistry - The name of the upstream registry.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • credentialArn

      CreatePullThroughCacheRuleRequest.Builder credentialArn(String credentialArn)

      The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that identifies the credentials to authenticate to the upstream registry.

      Parameters:
      credentialArn - The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that identifies the credentials to authenticate to the upstream registry.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customRoleArn

      CreatePullThroughCacheRuleRequest.Builder customRoleArn(String customRoleArn)

      Amazon Resource Name (ARN) of the IAM role to be assumed by Amazon ECR to authenticate to the ECR upstream registry. This role must be in the same account as the registry that you are configuring.

      Parameters:
      customRoleArn - Amazon Resource Name (ARN) of the IAM role to be assumed by Amazon ECR to authenticate to the ECR upstream registry. This role must be in the same account as the registry that you are configuring.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • upstreamRepositoryPrefix

      CreatePullThroughCacheRuleRequest.Builder upstreamRepositoryPrefix(String upstreamRepositoryPrefix)

      The repository name prefix of the upstream registry to match with the upstream repository name. When this field isn't specified, Amazon ECR will use the ROOT.

      Parameters:
      upstreamRepositoryPrefix - The repository name prefix of the upstream registry to match with the upstream repository name. When this field isn't specified, Amazon ECR will use the ROOT.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreatePullThroughCacheRuleRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreatePullThroughCacheRuleRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.