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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb

Overview

Represents an FinSpace environment.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aws_account_idString

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

Returns:

  • (String)


188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 188

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_idString

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

Returns:

  • (String)


188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 188

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

#descriptionString

The description of the FinSpace environment.

Returns:

  • (String)


188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 188

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_arnString

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

Returns:

  • (String)


188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 188

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_idString

The identifier of the FinSpace environment.

Returns:

  • (String)


188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 188

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_urlString

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

Returns:

  • (String)


188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 188

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_modeString

The authentication mode for the environment.

Returns:

  • (String)


188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 188

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_parametersTypes::FederationParameters

Configuration information when authentication mode is FEDERATED.



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 188

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_idString

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

Returns:

  • (String)


188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 188

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

#nameString

The name of the FinSpace environment.

Returns:

  • (String)


188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 188

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_urlString

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

Returns:

  • (String)


188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 188

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

#statusString

The current status of creation of the FinSpace environment.

Returns:

  • (String)


188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 188

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