Class: Aws::Finspace::Types::Environment

Inherits:

Struct

• Object
• Struct
• Aws::Finspace::Types::Environment

Defined in:

gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb

Overview

Represents an FinSpace environment.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #aws_account_id ⇒ String

  The ID of the AWS account in which the FinSpace environment is created.

• #dedicated_service_account_id ⇒ String

  The AWS account ID of the dedicated service account associated with your FinSpace environment.

• #description ⇒ String

  The description of the FinSpace environment.

• #environment_arn ⇒ String

  The Amazon Resource Name (ARN) of your FinSpace environment.

• #environment_id ⇒ String

  The identifier of the FinSpace environment.

• #environment_url ⇒ String

  The sign-in URL for the web application of your FinSpace environment.

• #federation_mode ⇒ String

  The authentication mode for the environment.

• #federation_parameters ⇒ Types::FederationParameters

  Configuration information when authentication mode is FEDERATED.

• #kms_key_id ⇒ String

  The KMS key id used to encrypt in the FinSpace environment.

• #name ⇒ String

  The name of the FinSpace environment.

• #sage_maker_studio_domain_url ⇒ String

  The URL of the integrated FinSpace notebook environment in your web application.

• #status ⇒ String

  The current status of creation of the FinSpace environment.

Instance Attribute Details

#aws_account_id ⇒ String

The ID of the AWS account in which the FinSpace environment is created.

Returns:

• (String)

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

class Environment < Struct.new(
  :name,
  :environment_id,
  :aws_account_id,
  :status,
  :environment_url,
  :description,
  :environment_arn,
  :sage_maker_studio_domain_url,
  :kms_key_id,
  :dedicated_service_account_id,
  :federation_mode,
  :federation_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#dedicated_service_account_id ⇒ String

The AWS account ID of the dedicated service account associated with your FinSpace environment.

Returns:

• (String)

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

class Environment < Struct.new(
  :name,
  :environment_id,
  :aws_account_id,
  :status,
  :environment_url,
  :description,
  :environment_arn,
  :sage_maker_studio_domain_url,
  :kms_key_id,
  :dedicated_service_account_id,
  :federation_mode,
  :federation_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the FinSpace environment.

Returns:

• (String)

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

class Environment < Struct.new(
  :name,
  :environment_id,
  :aws_account_id,
  :status,
  :environment_url,
  :description,
  :environment_arn,
  :sage_maker_studio_domain_url,
  :kms_key_id,
  :dedicated_service_account_id,
  :federation_mode,
  :federation_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#environment_arn ⇒ String

The Amazon Resource Name (ARN) of your FinSpace environment.

Returns:

• (String)

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

class Environment < Struct.new(
  :name,
  :environment_id,
  :aws_account_id,
  :status,
  :environment_url,
  :description,
  :environment_arn,
  :sage_maker_studio_domain_url,
  :kms_key_id,
  :dedicated_service_account_id,
  :federation_mode,
  :federation_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#environment_id ⇒ String

The identifier of the FinSpace environment.

Returns:

• (String)

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

class Environment < Struct.new(
  :name,
  :environment_id,
  :aws_account_id,
  :status,
  :environment_url,
  :description,
  :environment_arn,
  :sage_maker_studio_domain_url,
  :kms_key_id,
  :dedicated_service_account_id,
  :federation_mode,
  :federation_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#environment_url ⇒ String

The sign-in URL for the web application of your FinSpace environment.

Returns:

• (String)

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

class Environment < Struct.new(
  :name,
  :environment_id,
  :aws_account_id,
  :status,
  :environment_url,
  :description,
  :environment_arn,
  :sage_maker_studio_domain_url,
  :kms_key_id,
  :dedicated_service_account_id,
  :federation_mode,
  :federation_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#federation_mode ⇒ String

The authentication mode for the environment.

Returns:

• (String)

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

class Environment < Struct.new(
  :name,
  :environment_id,
  :aws_account_id,
  :status,
  :environment_url,
  :description,
  :environment_arn,
  :sage_maker_studio_domain_url,
  :kms_key_id,
  :dedicated_service_account_id,
  :federation_mode,
  :federation_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#federation_parameters ⇒ Types::FederationParameters

Configuration information when authentication mode is FEDERATED.

Returns:

• (Types::FederationParameters)

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

class Environment < Struct.new(
  :name,
  :environment_id,
  :aws_account_id,
  :status,
  :environment_url,
  :description,
  :environment_arn,
  :sage_maker_studio_domain_url,
  :kms_key_id,
  :dedicated_service_account_id,
  :federation_mode,
  :federation_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ String

The KMS key id used to encrypt in the FinSpace environment.

Returns:

• (String)

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

class Environment < Struct.new(
  :name,
  :environment_id,
  :aws_account_id,
  :status,
  :environment_url,
  :description,
  :environment_arn,
  :sage_maker_studio_domain_url,
  :kms_key_id,
  :dedicated_service_account_id,
  :federation_mode,
  :federation_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the FinSpace environment.

Returns:

• (String)

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

class Environment < Struct.new(
  :name,
  :environment_id,
  :aws_account_id,
  :status,
  :environment_url,
  :description,
  :environment_arn,
  :sage_maker_studio_domain_url,
  :kms_key_id,
  :dedicated_service_account_id,
  :federation_mode,
  :federation_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#sage_maker_studio_domain_url ⇒ String

The URL of the integrated FinSpace notebook environment in your web application.

Returns:

• (String)

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

class Environment < Struct.new(
  :name,
  :environment_id,
  :aws_account_id,
  :status,
  :environment_url,
  :description,
  :environment_arn,
  :sage_maker_studio_domain_url,
  :kms_key_id,
  :dedicated_service_account_id,
  :federation_mode,
  :federation_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The current status of creation of the FinSpace environment.

Returns:

• (String)

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

class Environment < Struct.new(
  :name,
  :environment_id,
  :aws_account_id,
  :status,
  :environment_url,
  :description,
  :environment_arn,
  :sage_maker_studio_domain_url,
  :kms_key_id,
  :dedicated_service_account_id,
  :federation_mode,
  :federation_parameters)
  SENSITIVE = []
  include Aws::Structure
end