Class: Aws::Finspace::Types::UpdateEnvironmentRequest

Inherits:

Struct

• Object
• Struct
• Aws::Finspace::Types::UpdateEnvironmentRequest

Includes:

Structure

Defined in:

lib/aws-sdk-finspace/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #description ⇒ String

  The description of the environment.

• #environment_id ⇒ String

  The identifier of the FinSpace environment.

• #federation_mode ⇒ String

  Authentication mode for the environment.

• #federation_parameters ⇒ Types::FederationParameters

  Configuration information when authentication mode is FEDERATED.

• #name ⇒ String

  The name of the environment.

Instance Attribute Details

#description ⇒ String

The description of the environment.

Returns:

• (String)

# File 'lib/aws-sdk-finspace/types.rb', line 4801

class UpdateEnvironmentRequest < Struct.new(
  :environment_id,
  :name,
  :description,
  :federation_mode,
  :federation_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#environment_id ⇒ String

The identifier of the FinSpace environment.

Returns:

• (String)

# File 'lib/aws-sdk-finspace/types.rb', line 4801

class UpdateEnvironmentRequest < Struct.new(
  :environment_id,
  :name,
  :description,
  :federation_mode,
  :federation_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#federation_mode ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-finspace/types.rb', line 4801

class UpdateEnvironmentRequest < Struct.new(
  :environment_id,
  :name,
  :description,
  :federation_mode,
  :federation_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#federation_parameters ⇒ Types::FederationParameters

Configuration information when authentication mode is FEDERATED.

Returns:

• (Types::FederationParameters)

# File 'lib/aws-sdk-finspace/types.rb', line 4801

class UpdateEnvironmentRequest < Struct.new(
  :environment_id,
  :name,
  :description,
  :federation_mode,
  :federation_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the environment.

Returns:

• (String)

# File 'lib/aws-sdk-finspace/types.rb', line 4801

class UpdateEnvironmentRequest < Struct.new(
  :environment_id,
  :name,
  :description,
  :federation_mode,
  :federation_parameters)
  SENSITIVE = []
  include Aws::Structure
end