« blib/lib/Paws/IAM/CreateRoleResponse.pm
↑ Summary
blib/lib/Paws/IAM/CreateSAMLProviderResponse.pm »
| 1 | |||
| 2 | package Paws::IAM::CreateSAMLProvider; | ||
| 3 | use Moose; | ||
| 4 | has Name => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has SAMLMetadataDocument => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::IAM::Tag]'); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateSAMLProvider'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IAM::CreateSAMLProviderResponse'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'CreateSAMLProviderResult'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::IAM::CreateSAMLProvider - Arguments for method CreateSAMLProvider on L<Paws::IAM> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method CreateSAMLProvider on the | ||
| 24 | L<AWS Identity and Access Management|Paws::IAM> service. Use the attributes of this class | ||
| 25 | as arguments to method CreateSAMLProvider. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateSAMLProvider. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $iam = Paws->service('IAM'); | ||
| 32 | my $CreateSAMLProviderResponse = $iam->CreateSAMLProvider( | ||
| 33 | Name => 'MySAMLProviderNameType', | ||
| 34 | SAMLMetadataDocument => 'MySAMLMetadataDocumentType', | ||
| 35 | Tags => [ | ||
| 36 | { | ||
| 37 | Key => 'MytagKeyType', # min: 1, max: 128 | ||
| 38 | Value => 'MytagValueType', # max: 256 | ||
| 39 | |||
| 40 | }, | ||
| 41 | ... | ||
| 42 | ], # OPTIONAL | ||
| 43 | ); | ||
| 44 | |||
| 45 | # Results: | ||
| 46 | my $SAMLProviderArn = $CreateSAMLProviderResponse->SAMLProviderArn; | ||
| 47 | my $Tags = $CreateSAMLProviderResponse->Tags; | ||
| 48 | |||
| 49 | # Returns a L<Paws::IAM::CreateSAMLProviderResponse> object. | ||
| 50 | |||
| 51 | 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. | ||
| 52 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iam/CreateSAMLProvider> | ||
| 53 | |||
| 54 | =head1 ATTRIBUTES | ||
| 55 | |||
| 56 | |||
| 57 | =head2 B<REQUIRED> Name => Str | ||
| 58 | |||
| 59 | The name of the provider to create. | ||
| 60 | |||
| 61 | This parameter allows (through its regex pattern | ||
| 62 | (http://wikipedia.org/wiki/regex)) a string of characters consisting of | ||
| 63 | upper and lowercase alphanumeric characters with no spaces. You can | ||
| 64 | also include any of the following characters: _+=,.@- | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head2 B<REQUIRED> SAMLMetadataDocument => Str | ||
| 69 | |||
| 70 | An XML document generated by an identity provider (IdP) that supports | ||
| 71 | SAML 2.0. The document includes the issuer's name, expiration | ||
| 72 | information, and keys that can be used to validate the SAML | ||
| 73 | authentication response (assertions) that are received from the IdP. | ||
| 74 | You must generate the metadata document using the identity management | ||
| 75 | software that is used as your organization's IdP. | ||
| 76 | |||
| 77 | For more information, see About SAML 2.0-based federation | ||
| 78 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html) | ||
| 79 | in the I<IAM User Guide> | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head2 Tags => ArrayRef[L<Paws::IAM::Tag>] | ||
| 84 | |||
| 85 | A list of tags that you want to attach to the new IAM SAML provider. | ||
| 86 | Each tag consists of a key name and an associated value. For more | ||
| 87 | information about tagging, see Tagging IAM resources | ||
| 88 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the | ||
| 89 | I<IAM User Guide>. | ||
| 90 | |||
| 91 | If any one of the tags is invalid or if you exceed the allowed maximum | ||
| 92 | number of tags, then the entire request fails and the resource is not | ||
| 93 | created. | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | =head1 SEE ALSO | ||
| 99 | |||
| 100 | This class forms part of L<Paws>, documenting arguments for method CreateSAMLProvider in L<Paws::IAM> | ||
| 101 | |||
| 102 | =head1 BUGS and CONTRIBUTIONS | ||
| 103 | |||
| 104 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 105 | |||
| 106 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 107 | |||
| 108 | =cut | ||
| 109 |