« blib/lib/Paws/EKS/AssociateEncryptionConfigResponse.pm
↑ Summary
blib/lib/Paws/EKS/AssociateIdentityProviderConfigResponse.pm »
| 1 | |||
| 2 | package Paws::EKS::AssociateIdentityProviderConfig; | ||
| 3 | use Moose; | ||
| 4 | has ClientRequestToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'clientRequestToken'); | ||
| 5 | has ClusterName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'name', required => 1); | ||
| 6 | has Oidc => (is => 'ro', isa => 'Paws::EKS::OidcIdentityProviderConfigRequest', traits => ['NameInRequest'], request_name => 'oidc', required => 1); | ||
| 7 | has Tags => (is => 'ro', isa => 'Paws::EKS::TagMap', traits => ['NameInRequest'], request_name => 'tags'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'AssociateIdentityProviderConfig'); | ||
| 12 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/clusters/{name}/identity-provider-configs/associate'); | ||
| 13 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EKS::AssociateIdentityProviderConfigResponse'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::EKS::AssociateIdentityProviderConfig - Arguments for method AssociateIdentityProviderConfig on L<Paws::EKS> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method AssociateIdentityProviderConfig on the | ||
| 26 | L<Amazon Elastic Kubernetes Service|Paws::EKS> service. Use the attributes of this class | ||
| 27 | as arguments to method AssociateIdentityProviderConfig. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to AssociateIdentityProviderConfig. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $eks = Paws->service('EKS'); | ||
| 34 | my $AssociateIdentityProviderConfigResponse = | ||
| 35 | $eks->AssociateIdentityProviderConfig( | ||
| 36 | ClusterName => 'MyString', | ||
| 37 | Oidc => { | ||
| 38 | ClientId => 'MyString', | ||
| 39 | IdentityProviderConfigName => 'MyString', | ||
| 40 | IssuerUrl => 'MyString', | ||
| 41 | GroupsClaim => 'MyString', | ||
| 42 | GroupsPrefix => 'MyString', | ||
| 43 | RequiredClaims => { | ||
| 44 | 'MyrequiredClaimsKey' => 'MyrequiredClaimsValue' | ||
| 45 | , # key: min: 1, max: 63, value: min: 1, max: 253 | ||
| 46 | }, # OPTIONAL | ||
| 47 | UsernameClaim => 'MyString', | ||
| 48 | UsernamePrefix => 'MyString', | ||
| 49 | }, | ||
| 50 | ClientRequestToken => 'MyString', # OPTIONAL | ||
| 51 | Tags => { | ||
| 52 | 'MyTagKey' => 'MyTagValue', # key: min: 1, max: 128, value: max: 256 | ||
| 53 | }, # OPTIONAL | ||
| 54 | ); | ||
| 55 | |||
| 56 | # Results: | ||
| 57 | my $Tags = $AssociateIdentityProviderConfigResponse->Tags; | ||
| 58 | my $Update = $AssociateIdentityProviderConfigResponse->Update; | ||
| 59 | |||
| 60 | # Returns a L<Paws::EKS::AssociateIdentityProviderConfigResponse> object. | ||
| 61 | |||
| 62 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 63 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/eks/AssociateIdentityProviderConfig> | ||
| 64 | |||
| 65 | =head1 ATTRIBUTES | ||
| 66 | |||
| 67 | |||
| 68 | =head2 ClientRequestToken => Str | ||
| 69 | |||
| 70 | Unique, case-sensitive identifier that you provide to ensure the | ||
| 71 | idempotency of the request. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 B<REQUIRED> ClusterName => Str | ||
| 76 | |||
| 77 | The name of the cluster to associate the configuration to. | ||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head2 B<REQUIRED> Oidc => L<Paws::EKS::OidcIdentityProviderConfigRequest> | ||
| 82 | |||
| 83 | An object that represents an OpenID Connect (OIDC) identity provider | ||
| 84 | configuration. | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head2 Tags => L<Paws::EKS::TagMap> | ||
| 89 | |||
| 90 | The metadata to apply to the configuration to assist with | ||
| 91 | categorization and organization. Each tag consists of a key and an | ||
| 92 | optional value, both of which you define. | ||
| 93 | |||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | =head1 SEE ALSO | ||
| 98 | |||
| 99 | This class forms part of L<Paws>, documenting arguments for method AssociateIdentityProviderConfig in L<Paws::EKS> | ||
| 100 | |||
| 101 | =head1 BUGS and CONTRIBUTIONS | ||
| 102 | |||
| 103 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 104 | |||
| 105 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 106 | |||
| 107 | =cut | ||
| 108 |