Class: Aws::ECR::Types::CreatePullThroughCacheRuleRequest

Inherits:

Struct

• Object
• Struct
• Aws::ECR::Types::CreatePullThroughCacheRuleRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ecr/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #credential_arn ⇒ String

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

• #custom_role_arn ⇒ String

  Amazon Resource Name (ARN) of the IAM role to be assumed by Amazon ECR to authenticate to the ECR upstream registry.

• #ecr_repository_prefix ⇒ String

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

• #registry_id ⇒ String

  The Amazon Web Services account ID associated with the registry to create the pull through cache rule for.

• #upstream_registry ⇒ String

  The name of the upstream registry.

• #upstream_registry_url ⇒ String

  The registry URL of the upstream public registry to use as the source for the pull through cache rule.

• #upstream_repository_prefix ⇒ String

  The repository name prefix of the upstream registry to match with the upstream repository name.

Instance Attribute Details

#credential_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-ecr/types.rb', line 405

class CreatePullThroughCacheRuleRequest < Struct.new(
  :ecr_repository_prefix,
  :upstream_registry_url,
  :registry_id,
  :upstream_registry,
  :credential_arn,
  :custom_role_arn,
  :upstream_repository_prefix)
  SENSITIVE = []
  include Aws::Structure
end

#custom_role_arn ⇒ String

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:

• (String)

# File 'lib/aws-sdk-ecr/types.rb', line 405

class CreatePullThroughCacheRuleRequest < Struct.new(
  :ecr_repository_prefix,
  :upstream_registry_url,
  :registry_id,
  :upstream_registry,
  :credential_arn,
  :custom_role_arn,
  :upstream_repository_prefix)
  SENSITIVE = []
  include Aws::Structure
end

#ecr_repository_prefix ⇒ String

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:

• (String)

# File 'lib/aws-sdk-ecr/types.rb', line 405

class CreatePullThroughCacheRuleRequest < Struct.new(
  :ecr_repository_prefix,
  :upstream_registry_url,
  :registry_id,
  :upstream_registry,
  :credential_arn,
  :custom_role_arn,
  :upstream_repository_prefix)
  SENSITIVE = []
  include Aws::Structure
end

#registry_id ⇒ String

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:

• (String)

# File 'lib/aws-sdk-ecr/types.rb', line 405

class CreatePullThroughCacheRuleRequest < Struct.new(
  :ecr_repository_prefix,
  :upstream_registry_url,
  :registry_id,
  :upstream_registry,
  :credential_arn,
  :custom_role_arn,
  :upstream_repository_prefix)
  SENSITIVE = []
  include Aws::Structure
end

#upstream_registry ⇒ String

The name of the upstream registry.

Returns:

• (String)

# File 'lib/aws-sdk-ecr/types.rb', line 405

class CreatePullThroughCacheRuleRequest < Struct.new(
  :ecr_repository_prefix,
  :upstream_registry_url,
  :registry_id,
  :upstream_registry,
  :credential_arn,
  :custom_role_arn,
  :upstream_repository_prefix)
  SENSITIVE = []
  include Aws::Structure
end

#upstream_registry_url ⇒ String

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`) – `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:

• (String)

# File 'lib/aws-sdk-ecr/types.rb', line 405

class CreatePullThroughCacheRuleRequest < Struct.new(
  :ecr_repository_prefix,
  :upstream_registry_url,
  :registry_id,
  :upstream_registry,
  :credential_arn,
  :custom_role_arn,
  :upstream_repository_prefix)
  SENSITIVE = []
  include Aws::Structure
end

#upstream_repository_prefix ⇒ String

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:

• (String)

# File 'lib/aws-sdk-ecr/types.rb', line 405

class CreatePullThroughCacheRuleRequest < Struct.new(
  :ecr_repository_prefix,
  :upstream_registry_url,
  :registry_id,
  :upstream_registry,
  :credential_arn,
  :custom_role_arn,
  :upstream_repository_prefix)
  SENSITIVE = []
  include Aws::Structure
end