« blib/lib/Paws/Finspace/AttributeMap.pm
↑ Summary
blib/lib/Paws/Finspace/CreateEnvironmentResponse.pm »
| 1 | |||
| 2 | package Paws::Finspace::CreateEnvironment; | ||
| 3 | use Moose; | ||
| 4 | has Description => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'description'); | ||
| 5 | has FederationMode => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'federationMode'); | ||
| 6 | has FederationParameters => (is => 'ro', isa => 'Paws::Finspace::FederationParameters', traits => ['NameInRequest'], request_name => 'federationParameters'); | ||
| 7 | has KmsKeyId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'kmsKeyId'); | ||
| 8 | has Name => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'name', required => 1); | ||
| 9 | has Tags => (is => 'ro', isa => 'Paws::Finspace::TagMap', traits => ['NameInRequest'], request_name => 'tags'); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateEnvironment'); | ||
| 14 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/environment'); | ||
| 15 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Finspace::CreateEnvironmentResponse'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::Finspace::CreateEnvironment - Arguments for method CreateEnvironment on L<Paws::Finspace> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method CreateEnvironment on the | ||
| 28 | L<FinSpace User Environment Management service|Paws::Finspace> service. Use the attributes of this class | ||
| 29 | as arguments to method CreateEnvironment. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateEnvironment. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $finspace = Paws->service('Finspace'); | ||
| 36 | my $CreateEnvironmentResponse = $finspace->CreateEnvironment( | ||
| 37 | Name => 'MyEnvironmentName', | ||
| 38 | Description => 'MyDescription', # OPTIONAL | ||
| 39 | FederationMode => 'FEDERATED', # OPTIONAL | ||
| 40 | FederationParameters => { | ||
| 41 | ApplicationCallBackURL => 'Myurl', # min: 1, max: 1000; OPTIONAL | ||
| 42 | AttributeMap => { | ||
| 43 | 'MyFederationAttributeKey' => | ||
| 44 | 'Myurl', # key: min: 1, max: 32, value: min: 1, max: 1000; OPTIONAL | ||
| 45 | }, # OPTIONAL | ||
| 46 | FederationProviderName => | ||
| 47 | 'MyFederationProviderName', # min: 1, max: 32; OPTIONAL | ||
| 48 | FederationURN => 'Myurn', # min: 1, max: 255; OPTIONAL | ||
| 49 | SamlMetadataDocument => | ||
| 50 | 'MySamlMetadataDocument', # min: 1000, max: 10000000; OPTIONAL | ||
| 51 | SamlMetadataURL => 'Myurl', # min: 1, max: 1000; OPTIONAL | ||
| 52 | }, # OPTIONAL | ||
| 53 | KmsKeyId => 'MyKmsKeyId', # OPTIONAL | ||
| 54 | Tags => { | ||
| 55 | 'MyTagKey' => | ||
| 56 | 'MyTagValue', # key: min: 1, max: 128, value: min: 1, max: 256 | ||
| 57 | }, # OPTIONAL | ||
| 58 | ); | ||
| 59 | |||
| 60 | # Results: | ||
| 61 | my $EnvironmentArn = $CreateEnvironmentResponse->EnvironmentArn; | ||
| 62 | my $EnvironmentId = $CreateEnvironmentResponse->EnvironmentId; | ||
| 63 | my $EnvironmentUrl = $CreateEnvironmentResponse->EnvironmentUrl; | ||
| 64 | |||
| 65 | # Returns a L<Paws::Finspace::CreateEnvironmentResponse> object. | ||
| 66 | |||
| 67 | 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. | ||
| 68 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/finspace/CreateEnvironment> | ||
| 69 | |||
| 70 | =head1 ATTRIBUTES | ||
| 71 | |||
| 72 | |||
| 73 | =head2 Description => Str | ||
| 74 | |||
| 75 | The description of the FinSpace environment to be created. | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head2 FederationMode => Str | ||
| 80 | |||
| 81 | Authentication mode for the environment. | ||
| 82 | |||
| 83 | =over | ||
| 84 | |||
| 85 | =item * | ||
| 86 | |||
| 87 | C<FEDERATED> - Users access FinSpace through Single Sign On (SSO) via | ||
| 88 | your Identity provider. | ||
| 89 | |||
| 90 | =item * | ||
| 91 | |||
| 92 | C<LOCAL> - Users access FinSpace via email and password managed within | ||
| 93 | the FinSpace environment. | ||
| 94 | |||
| 95 | =back | ||
| 96 | |||
| 97 | |||
| 98 | Valid values are: C<"FEDERATED">, C<"LOCAL"> | ||
| 99 | |||
| 100 | =head2 FederationParameters => L<Paws::Finspace::FederationParameters> | ||
| 101 | |||
| 102 | Configuration information when authentication mode is FEDERATED. | ||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | =head2 KmsKeyId => Str | ||
| 107 | |||
| 108 | The KMS key id to encrypt your data in the FinSpace environment. | ||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | =head2 B<REQUIRED> Name => Str | ||
| 113 | |||
| 114 | The name of the FinSpace environment to be created. | ||
| 115 | |||
| 116 | |||
| 117 | |||
| 118 | =head2 Tags => L<Paws::Finspace::TagMap> | ||
| 119 | |||
| 120 | Add tags to your FinSpace environment. | ||
| 121 | |||
| 122 | |||
| 123 | |||
| 124 | |||
| 125 | =head1 SEE ALSO | ||
| 126 | |||
| 127 | This class forms part of L<Paws>, documenting arguments for method CreateEnvironment in L<Paws::Finspace> | ||
| 128 | |||
| 129 | =head1 BUGS and CONTRIBUTIONS | ||
| 130 | |||
| 131 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 132 | |||
| 133 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 134 | |||
| 135 | =cut | ||
| 136 |