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

Class CreatePullThroughCacheRuleRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreatePullThroughCacheRuleRequest.Builder,CreatePullThroughCacheRuleRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreatePullThroughCacheRuleRequest
extends EcrRequest
implements ToCopyableBuilder<CreatePullThroughCacheRuleRequest.Builder,CreatePullThroughCacheRuleRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreatePullThroughCacheRuleRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreatePullThroughCacheRuleRequest.Builder	builder()
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.
String	customRoleArn()	Amazon Resource Name (ARN) of the IAM role to be assumed by Amazon ECR to authenticate to the ECR upstream registry.
String	ecrRepositoryPrefix()	The repository name prefix to use when caching images from the source registry.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	registryId()	The Amazon Web Services account ID associated with the registry to create the pull through cache rule for.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CreatePullThroughCacheRuleRequest.Builder>	serializableBuilderClass()
CreatePullThroughCacheRuleRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
UpstreamRegistry	upstreamRegistry()	The name of the upstream registry.
String	upstreamRegistryAsString()	The name of the upstream registry.
String	upstreamRegistryUrl()	The registry URL of the upstream public registry to use as the source for the pull through cache rule.
String	upstreamRepositoryPrefix()	The repository name prefix of the upstream registry to match with the upstream repository name.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

ecrRepositoryPrefix

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

Returns:

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

upstreamRegistryUrl

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

Returns:

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

registryId

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

Returns:

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.

upstreamRegistry

public final UpstreamRegistry upstreamRegistry()

The name of the upstream registry.

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

Returns:

The name of the upstream registry.

See Also:

UpstreamRegistry

upstreamRegistryAsString

public final String upstreamRegistryAsString()

The name of the upstream registry.

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

Returns:

The name of the upstream registry.

See Also:

UpstreamRegistry

credentialArn

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

Returns:

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

customRoleArn

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

Returns:

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.

upstreamRepositoryPrefix

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

Returns:

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.

toBuilder

public CreatePullThroughCacheRuleRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreatePullThroughCacheRuleRequest.Builder,CreatePullThroughCacheRuleRequest>

Specified by:

toBuilder in class EcrRequest

builder

public static CreatePullThroughCacheRuleRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreatePullThroughCacheRuleRequest.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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo