aws_sdk_ecr/client/validate_pull_through_cache_rule.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`ValidatePullThroughCacheRule`](crate::operation::validate_pull_through_cache_rule::builders::ValidatePullThroughCacheRuleFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`ecr_repository_prefix(impl Into<String>)`](crate::operation::validate_pull_through_cache_rule::builders::ValidatePullThroughCacheRuleFluentBuilder::ecr_repository_prefix) / [`set_ecr_repository_prefix(Option<String>)`](crate::operation::validate_pull_through_cache_rule::builders::ValidatePullThroughCacheRuleFluentBuilder::set_ecr_repository_prefix):<br>required: **true**<br><p>The repository name prefix associated with the pull through cache rule.</p><br>
7 /// - [`registry_id(impl Into<String>)`](crate::operation::validate_pull_through_cache_rule::builders::ValidatePullThroughCacheRuleFluentBuilder::registry_id) / [`set_registry_id(Option<String>)`](crate::operation::validate_pull_through_cache_rule::builders::ValidatePullThroughCacheRuleFluentBuilder::set_registry_id):<br>required: **false**<br><p>The registry ID associated with the pull through cache rule. If you do not specify a registry, the default registry is assumed.</p><br>
8 /// - On success, responds with [`ValidatePullThroughCacheRuleOutput`](crate::operation::validate_pull_through_cache_rule::ValidatePullThroughCacheRuleOutput) with field(s):
9 /// - [`ecr_repository_prefix(Option<String>)`](crate::operation::validate_pull_through_cache_rule::ValidatePullThroughCacheRuleOutput::ecr_repository_prefix): <p>The Amazon ECR repository prefix associated with the pull through cache rule.</p>
10 /// - [`registry_id(Option<String>)`](crate::operation::validate_pull_through_cache_rule::ValidatePullThroughCacheRuleOutput::registry_id): <p>The registry ID associated with the request.</p>
11 /// - [`upstream_registry_url(Option<String>)`](crate::operation::validate_pull_through_cache_rule::ValidatePullThroughCacheRuleOutput::upstream_registry_url): <p>The upstream registry URL associated with the pull through cache rule.</p>
12 /// - [`credential_arn(Option<String>)`](crate::operation::validate_pull_through_cache_rule::ValidatePullThroughCacheRuleOutput::credential_arn): <p>The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret associated with the pull through cache rule.</p>
13 /// - [`custom_role_arn(Option<String>)`](crate::operation::validate_pull_through_cache_rule::ValidatePullThroughCacheRuleOutput::custom_role_arn): <p>The ARN of the IAM role associated with the pull through cache rule.</p>
14 /// - [`upstream_repository_prefix(Option<String>)`](crate::operation::validate_pull_through_cache_rule::ValidatePullThroughCacheRuleOutput::upstream_repository_prefix): <p>The upstream repository prefix associated with the pull through cache rule.</p>
15 /// - [`is_valid(bool)`](crate::operation::validate_pull_through_cache_rule::ValidatePullThroughCacheRuleOutput::is_valid): <p>Whether or not the pull through cache rule was validated. If <code>true</code>, Amazon ECR was able to reach the upstream registry and authentication was successful. If <code>false</code>, there was an issue and validation failed. The <code>failure</code> reason indicates the cause.</p>
16 /// - [`failure(Option<String>)`](crate::operation::validate_pull_through_cache_rule::ValidatePullThroughCacheRuleOutput::failure): <p>The reason the validation failed. For more details about possible causes and how to address them, see <a href="https://docs.aws.amazon.com/AmazonECR/latest/userguide/pull-through-cache.html">Using pull through cache rules</a> in the <i>Amazon Elastic Container Registry User Guide</i>.</p>
17 /// - On failure, responds with [`SdkError<ValidatePullThroughCacheRuleError>`](crate::operation::validate_pull_through_cache_rule::ValidatePullThroughCacheRuleError)
18 pub fn validate_pull_through_cache_rule(
19 &self,
20 ) -> crate::operation::validate_pull_through_cache_rule::builders::ValidatePullThroughCacheRuleFluentBuilder {
21 crate::operation::validate_pull_through_cache_rule::builders::ValidatePullThroughCacheRuleFluentBuilder::new(self.handle.clone())
22 }
23}