NAME

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

DESCRIPTION

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

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

SYNOPSIS

    my $finspace = Paws->service('Finspace');
    my $UpdateEnvironmentResponse = $finspace->UpdateEnvironment(
      EnvironmentId        => 'MyIdType',
      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
      Name => 'MyEnvironmentName',    # OPTIONAL
    );

    # Results:
    my $Environment = $UpdateEnvironmentResponse->Environment;

    # Returns a L<Paws::Finspace::UpdateEnvironmentResponse> 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/UpdateEnvironment

ATTRIBUTES

Description => Str

The description of the environment.

REQUIRED EnvironmentId => Str

The identifier of the FinSpace environment.

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

Name => Str

The name of the environment.

SEE ALSO

This class forms part of Paws, documenting arguments for method UpdateEnvironment 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