/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::Finspace::CreateEnvironment

NAME

Paws::Finspace::CreateEnvironment - Arguments for method CreateEnvironment on Paws::Finspace

DESCRIPTION

This class represents the parameters used for calling the method CreateEnvironment on the FinSpace User Environment Management service service. Use the attributes of this class as arguments to method CreateEnvironment.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateEnvironment.

SYNOPSIS

my $finspace = Paws->service('Finspace');
my $CreateEnvironmentResponse = $finspace->CreateEnvironment(
  Name                 => 'MyEnvironmentName',
  Description          => 'MyDescription',       # OPTIONAL
  FederationMode       => 'FEDERATED',           # OPTIONAL
  FederationParameters => {
    ApplicationCallBackURL => 'Myurl',    # min: 1, max: 1000; OPTIONAL
    AttributeMap           => {
      'MyFederationAttributeKey' =>
        'Myurl',  # key: min: 1, max: 32, value: min: 1, max: 1000; OPTIONAL
    },    # OPTIONAL
    FederationProviderName =>
      'MyFederationProviderName',    # min: 1, max: 32; OPTIONAL
    FederationURN        => 'Myurn', # min: 1, max: 255; OPTIONAL
    SamlMetadataDocument =>
      'MySamlMetadataDocument',      # min: 1000, max: 10000000; OPTIONAL
    SamlMetadataURL => 'Myurl',      # min: 1, max: 1000; OPTIONAL
  },    # OPTIONAL
  KmsKeyId => 'MyKmsKeyId',    # OPTIONAL
  Tags     => {
    'MyTagKey' =>
      'MyTagValue',    # key: min: 1, max: 128, value: min: 1, max: 256
  },    # OPTIONAL
);

# Results:
my $EnvironmentArn = $CreateEnvironmentResponse->EnvironmentArn;
my $EnvironmentId  = $CreateEnvironmentResponse->EnvironmentId;
my $EnvironmentUrl = $CreateEnvironmentResponse->EnvironmentUrl;

# Returns a L<Paws::Finspace::CreateEnvironmentResponse> object.

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. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/finspace/CreateEnvironment

ATTRIBUTES

Description => Str

The description of the FinSpace environment to be created.

FederationMode => Str

Authentication mode for the environment.

  • FEDERATED - Users access FinSpace through Single Sign On (SSO) via your Identity provider.

  • LOCAL - Users access FinSpace via email and password managed within the FinSpace environment.

Valid values are: "FEDERATED", "LOCAL"

FederationParameters => Paws::Finspace::FederationParameters

Configuration information when authentication mode is FEDERATED.

KmsKeyId => Str

The KMS key id to encrypt your data in the FinSpace environment.

REQUIRED Name => Str

The name of the FinSpace environment to be created.

Tags => Paws::Finspace::TagMap

Add tags to your FinSpace environment.

SEE ALSO

This class forms part of Paws, documenting arguments for method CreateEnvironment in Paws::Finspace

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues