| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CodeBuild::RegistryCredential; | ||
| 3 | use Moose; | ||
| 4 | has Credential => (is => 'ro', isa => 'Str', request_name => 'credential', traits => ['NameInRequest'], required => 1); | ||
| 5 | has CredentialProvider => (is => 'ro', isa => 'Str', request_name => 'credentialProvider', traits => ['NameInRequest'], required => 1); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::CodeBuild::RegistryCredential | ||
| 14 | |||
| 15 | =head1 USAGE | ||
| 16 | |||
| 17 | This class represents one of two things: | ||
| 18 | |||
| 19 | =head3 Arguments in a call to a service | ||
| 20 | |||
| 21 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 22 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 23 | |||
| 24 | As an example, if Att1 is expected to be a Paws::CodeBuild::RegistryCredential object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { Credential => $value, ..., CredentialProvider => $value }); | ||
| 27 | |||
| 28 | =head3 Results returned from an API call | ||
| 29 | |||
| 30 | Use accessors for each attribute. If Att1 is expected to be an Paws::CodeBuild::RegistryCredential object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->Credential | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | Information about credentials that provide access to a private Docker | ||
| 38 | registry. When this is set: | ||
| 39 | |||
| 40 | =over | ||
| 41 | |||
| 42 | =item * | ||
| 43 | |||
| 44 | C<imagePullCredentialsType> must be set to C<SERVICE_ROLE>. | ||
| 45 | |||
| 46 | =item * | ||
| 47 | |||
| 48 | images cannot be curated or an Amazon ECR image. | ||
| 49 | |||
| 50 | =back | ||
| 51 | |||
| 52 | For more information, see Private Registry with Secrets Manager Sample | ||
| 53 | for CodeBuild | ||
| 54 | (https://docs.aws.amazon.com/codebuild/latest/userguide/sample-private-registry.html). | ||
| 55 | |||
| 56 | =head1 ATTRIBUTES | ||
| 57 | |||
| 58 | |||
| 59 | =head2 B<REQUIRED> Credential => Str | ||
| 60 | |||
| 61 | The Amazon Resource Name (ARN) or name of credentials created using | ||
| 62 | Secrets Manager. | ||
| 63 | |||
| 64 | The C<credential> can use the name of the credentials only if they | ||
| 65 | exist in your current Region. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 B<REQUIRED> CredentialProvider => Str | ||
| 69 | |||
| 70 | The service that created the credentials to access a private Docker | ||
| 71 | registry. The valid value, SECRETS_MANAGER, is for Secrets Manager. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head1 SEE ALSO | ||
| 76 | |||
| 77 | This class forms part of L<Paws>, describing an object used in L<Paws::CodeBuild> | ||
| 78 | |||
| 79 | =head1 BUGS and CONTRIBUTIONS | ||
| 80 | |||
| 81 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 82 | |||
| 83 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 84 | |||
| 85 | =cut | ||
| 86 |