UpdatePullThroughCacheRule
Updates an existing pull through cache rule.
Request Syntax
{
"credentialArn": "string
",
"customRoleArn": "string
",
"ecrRepositoryPrefix": "string
",
"registryId": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- credentialArn
-
The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that identifies the credentials to authenticate to the upstream registry.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 612.
Pattern:
^arn:aws:secretsmanager:[a-zA-Z0-9-:]+:secret:ecr\-pullthroughcache\/[a-zA-Z0-9\/_+=.@-]+$
Required: No
- 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.
Type: String
Length Constraints: Maximum length of 2048.
Required: No
- ecrRepositoryPrefix
-
The repository name prefix to use when caching images from the source registry.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 30.
Pattern:
^((?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*/?|ROOT)$
Required: Yes
- registryId
-
The AWS account ID associated with the registry associated with the pull through cache rule. If you do not specify a registry, the default registry is assumed.
Type: String
Pattern:
[0-9]{12}
Required: No
Response Syntax
{
"credentialArn": "string",
"customRoleArn": "string",
"ecrRepositoryPrefix": "string",
"registryId": "string",
"updatedAt": number,
"upstreamRepositoryPrefix": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- credentialArn
-
The Amazon Resource Name (ARN) of the AWS Secrets Manager secret associated with the pull through cache rule.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 612.
Pattern:
^arn:aws:secretsmanager:[a-zA-Z0-9-:]+:secret:ecr\-pullthroughcache\/[a-zA-Z0-9\/_+=.@-]+$
- customRoleArn
-
The ARN of the IAM role associated with the pull through cache rule.
Type: String
Length Constraints: Maximum length of 2048.
- ecrRepositoryPrefix
-
The Amazon ECR repository prefix associated with the pull through cache rule.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 30.
Pattern:
^((?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*/?|ROOT)$
- registryId
-
The registry ID associated with the request.
Type: String
Pattern:
[0-9]{12}
- updatedAt
-
The date and time, in JavaScript date format, when the pull through cache rule was updated.
Type: Timestamp
- upstreamRepositoryPrefix
-
The upstream repository prefix associated with the pull through cache rule.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 30.
Pattern:
^((?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*/?|ROOT)$
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidParameterException
-
The specified parameter is invalid. Review the available parameters for the API request.
HTTP Status Code: 400
- PullThroughCacheRuleNotFoundException
-
The pull through cache rule was not found. Specify a valid pull through cache rule and try again.
HTTP Status Code: 400
- SecretNotFoundException
-
The ARN of the secret specified in the pull through cache rule was not found. Update the pull through cache rule with a valid secret ARN and try again.
HTTP Status Code: 400
- ServerException
-
These errors are usually caused by a server-side issue.
HTTP Status Code: 500
- UnableToAccessSecretException
-
The secret is unable to be accessed. Verify the resource permissions for the secret and try again.
HTTP Status Code: 400
- UnableToDecryptSecretValueException
-
The secret is accessible but is unable to be decrypted. Verify the resource permisisons and try again.
HTTP Status Code: 400
- ValidationException
-
There was an exception validating this request.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: