Class: Aws::Finspace::Types::GetKxEnvironmentResponse

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#availability_zone_ids ⇒ Array<String>

The identifier of the availability zones where subnets for the environment are created.

Returns:

  • (Array<String>) 


2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
 
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 2580

class GetKxEnvironmentResponse < Struct.new(
  :name,
  :environment_id,
  :aws_account_id,
  :status,
  :tgw_status,
  :dns_status,
  :error_message,
  :description,
  :environment_arn,
  :kms_key_id,
  :dedicated_service_account_id,
  :transit_gateway_configuration,
  :custom_dns_configuration,
  :creation_timestamp,
  :update_timestamp,
  :availability_zone_ids,
  :certificate_authority_arn)
  SENSITIVE = []
  include Aws::Structure
end

#aws_account_id ⇒ String

The unique identifier of the AWS account that is used to create the kdb environment.

Returns:

  • (String) 


2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
 
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 2580

class GetKxEnvironmentResponse < Struct.new(
  :name,
  :environment_id,
  :aws_account_id,
  :status,
  :tgw_status,
  :dns_status,
  :error_message,
  :description,
  :environment_arn,
  :kms_key_id,
  :dedicated_service_account_id,
  :transit_gateway_configuration,
  :custom_dns_configuration,
  :creation_timestamp,
  :update_timestamp,
  :availability_zone_ids,
  :certificate_authority_arn)
  SENSITIVE = []
  include Aws::Structure
end

#certificate_authority_arn ⇒ String

The Amazon Resource Name (ARN) of the certificate authority of the kdb environment.

Returns:

  • (String) 


2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
 
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 2580

class GetKxEnvironmentResponse < Struct.new(
  :name,
  :environment_id,
  :aws_account_id,
  :status,
  :tgw_status,
  :dns_status,
  :error_message,
  :description,
  :environment_arn,
  :kms_key_id,
  :dedicated_service_account_id,
  :transit_gateway_configuration,
  :custom_dns_configuration,
  :creation_timestamp,
  :update_timestamp,
  :availability_zone_ids,
  :certificate_authority_arn)
  SENSITIVE = []
  include Aws::Structure
end

#creation_timestamp ⇒ Time

The timestamp at which the kdb environment was created in FinSpace.

Returns:

  • (Time) 


2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
 
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 2580

class GetKxEnvironmentResponse < Struct.new(
  :name,
  :environment_id,
  :aws_account_id,
  :status,
  :tgw_status,
  :dns_status,
  :error_message,
  :description,
  :environment_arn,
  :kms_key_id,
  :dedicated_service_account_id,
  :transit_gateway_configuration,
  :custom_dns_configuration,
  :creation_timestamp,
  :update_timestamp,
  :availability_zone_ids,
  :certificate_authority_arn)
  SENSITIVE = []
  include Aws::Structure
end

#custom_dns_configuration ⇒ Array<Types::CustomDNSServer>

A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.

Returns:



2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
 
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 2580

class GetKxEnvironmentResponse < Struct.new(
  :name,
  :environment_id,
  :aws_account_id,
  :status,
  :tgw_status,
  :dns_status,
  :error_message,
  :description,
  :environment_arn,
  :kms_key_id,
  :dedicated_service_account_id,
  :transit_gateway_configuration,
  :custom_dns_configuration,
  :creation_timestamp,
  :update_timestamp,
  :availability_zone_ids,
  :certificate_authority_arn)
  SENSITIVE = []
  include Aws::Structure
end

#dedicated_service_account_id ⇒ String

A unique identifier for the AWS environment infrastructure account.

Returns:

  • (String) 


2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
 
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 2580

class GetKxEnvironmentResponse < Struct.new(
  :name,
  :environment_id,
  :aws_account_id,
  :status,
  :tgw_status,
  :dns_status,
  :error_message,
  :description,
  :environment_arn,
  :kms_key_id,
  :dedicated_service_account_id,
  :transit_gateway_configuration,
  :custom_dns_configuration,
  :creation_timestamp,
  :update_timestamp,
  :availability_zone_ids,
  :certificate_authority_arn)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description for the kdb environment.

Returns:

  • (String) 


2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
 
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 2580

class GetKxEnvironmentResponse < Struct.new(
  :name,
  :environment_id,
  :aws_account_id,
  :status,
  :tgw_status,
  :dns_status,
  :error_message,
  :description,
  :environment_arn,
  :kms_key_id,
  :dedicated_service_account_id,
  :transit_gateway_configuration,
  :custom_dns_configuration,
  :creation_timestamp,
  :update_timestamp,
  :availability_zone_ids,
  :certificate_authority_arn)
  SENSITIVE = []
  include Aws::Structure
end

#dns_status ⇒ String

The status of DNS configuration.

Returns:

  • (String) 


2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
 
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 2580

class GetKxEnvironmentResponse < Struct.new(
  :name,
  :environment_id,
  :aws_account_id,
  :status,
  :tgw_status,
  :dns_status,
  :error_message,
  :description,
  :environment_arn,
  :kms_key_id,
  :dedicated_service_account_id,
  :transit_gateway_configuration,
  :custom_dns_configuration,
  :creation_timestamp,
  :update_timestamp,
  :availability_zone_ids,
  :certificate_authority_arn)
  SENSITIVE = []
  include Aws::Structure
end

#environment_arn ⇒ String

The ARN identifier of the environment.

Returns:

  • (String) 


2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
 
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 2580

class GetKxEnvironmentResponse < Struct.new(
  :name,
  :environment_id,
  :aws_account_id,
  :status,
  :tgw_status,
  :dns_status,
  :error_message,
  :description,
  :environment_arn,
  :kms_key_id,
  :dedicated_service_account_id,
  :transit_gateway_configuration,
  :custom_dns_configuration,
  :creation_timestamp,
  :update_timestamp,
  :availability_zone_ids,
  :certificate_authority_arn)
  SENSITIVE = []
  include Aws::Structure
end

#environment_id ⇒ String

A unique identifier for the kdb environment.

Returns:

  • (String) 


2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
 
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 2580

class GetKxEnvironmentResponse < Struct.new(
  :name,
  :environment_id,
  :aws_account_id,
  :status,
  :tgw_status,
  :dns_status,
  :error_message,
  :description,
  :environment_arn,
  :kms_key_id,
  :dedicated_service_account_id,
  :transit_gateway_configuration,
  :custom_dns_configuration,
  :creation_timestamp,
  :update_timestamp,
  :availability_zone_ids,
  :certificate_authority_arn)
  SENSITIVE = []
  include Aws::Structure
end

#error_message ⇒ String

Specifies the error message that appears if a flow fails.

Returns:

  • (String) 


2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
 
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 2580

class GetKxEnvironmentResponse < Struct.new(
  :name,
  :environment_id,
  :aws_account_id,
  :status,
  :tgw_status,
  :dns_status,
  :error_message,
  :description,
  :environment_arn,
  :kms_key_id,
  :dedicated_service_account_id,
  :transit_gateway_configuration,
  :custom_dns_configuration,
  :creation_timestamp,
  :update_timestamp,
  :availability_zone_ids,
  :certificate_authority_arn)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ String

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

Returns:

  • (String) 


2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
 
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 2580

class GetKxEnvironmentResponse < Struct.new(
  :name,
  :environment_id,
  :aws_account_id,
  :status,
  :tgw_status,
  :dns_status,
  :error_message,
  :description,
  :environment_arn,
  :kms_key_id,
  :dedicated_service_account_id,
  :transit_gateway_configuration,
  :custom_dns_configuration,
  :creation_timestamp,
  :update_timestamp,
  :availability_zone_ids,
  :certificate_authority_arn)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the kdb environment.

Returns:

  • (String) 


2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
 
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 2580

class GetKxEnvironmentResponse < Struct.new(
  :name,
  :environment_id,
  :aws_account_id,
  :status,
  :tgw_status,
  :dns_status,
  :error_message,
  :description,
  :environment_arn,
  :kms_key_id,
  :dedicated_service_account_id,
  :transit_gateway_configuration,
  :custom_dns_configuration,
  :creation_timestamp,
  :update_timestamp,
  :availability_zone_ids,
  :certificate_authority_arn)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the kdb environment.

Returns:

  • (String) 


2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
 
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 2580

class GetKxEnvironmentResponse < Struct.new(
  :name,
  :environment_id,
  :aws_account_id,
  :status,
  :tgw_status,
  :dns_status,
  :error_message,
  :description,
  :environment_arn,
  :kms_key_id,
  :dedicated_service_account_id,
  :transit_gateway_configuration,
  :custom_dns_configuration,
  :creation_timestamp,
  :update_timestamp,
  :availability_zone_ids,
  :certificate_authority_arn)
  SENSITIVE = []
  include Aws::Structure
end

#tgw_status ⇒ String

The status of the network configuration.

Returns:

  • (String) 


2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
 
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 2580

class GetKxEnvironmentResponse < Struct.new(
  :name,
  :environment_id,
  :aws_account_id,
  :status,
  :tgw_status,
  :dns_status,
  :error_message,
  :description,
  :environment_arn,
  :kms_key_id,
  :dedicated_service_account_id,
  :transit_gateway_configuration,
  :custom_dns_configuration,
  :creation_timestamp,
  :update_timestamp,
  :availability_zone_ids,
  :certificate_authority_arn)
  SENSITIVE = []
  include Aws::Structure
end

#transit_gateway_configuration ⇒ Types::TransitGatewayConfiguration

The structure of the transit gateway and network configuration that is used to connect the kdb environment to an internal network.

Returns:



2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
 
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 2580

class GetKxEnvironmentResponse < Struct.new(
  :name,
  :environment_id,
  :aws_account_id,
  :status,
  :tgw_status,
  :dns_status,
  :error_message,
  :description,
  :environment_arn,
  :kms_key_id,
  :dedicated_service_account_id,
  :transit_gateway_configuration,
  :custom_dns_configuration,
  :creation_timestamp,
  :update_timestamp,
  :availability_zone_ids,
  :certificate_authority_arn)
  SENSITIVE = []
  include Aws::Structure
end

#update_timestamp ⇒ Time

The timestamp at which the kdb environment was updated.

Returns:

  • (Time) 


2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
 
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 2580

class GetKxEnvironmentResponse < Struct.new(
  :name,
  :environment_id,
  :aws_account_id,
  :status,
  :tgw_status,
  :dns_status,
  :error_message,
  :description,
  :environment_arn,
  :kms_key_id,
  :dedicated_service_account_id,
  :transit_gateway_configuration,
  :custom_dns_configuration,
  :creation_timestamp,
  :update_timestamp,
  :availability_zone_ids,
  :certificate_authority_arn)
  SENSITIVE = []
  include Aws::Structure
end