Class: Aws::Finspace::Types::KxEnvironment

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

Overview

The details of a kdb environment.

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>) 


3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
 
# File 'lib/aws-sdk-finspace/types.rb', line 3696

class KxEnvironment < 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 in which you create the kdb environment.

Returns:

  • (String) 


3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
 
# File 'lib/aws-sdk-finspace/types.rb', line 3696

class KxEnvironment < 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:

Returns:

  • (String) 


3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
 
# File 'lib/aws-sdk-finspace/types.rb', line 3696

class KxEnvironment < 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. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

Returns:

  • (Time) 


3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
 
# File 'lib/aws-sdk-finspace/types.rb', line 3696

class KxEnvironment < 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:



3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
 
# File 'lib/aws-sdk-finspace/types.rb', line 3696

class KxEnvironment < 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) 


3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
 
# File 'lib/aws-sdk-finspace/types.rb', line 3696

class KxEnvironment < 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 of the kdb environment.

Returns:

  • (String) 


3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
 
# File 'lib/aws-sdk-finspace/types.rb', line 3696

class KxEnvironment < 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) 


3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
 
# File 'lib/aws-sdk-finspace/types.rb', line 3696

class KxEnvironment < 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 Amazon Resource Name (ARN) of your kdb environment.

Returns:

  • (String) 


3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
 
# File 'lib/aws-sdk-finspace/types.rb', line 3696

class KxEnvironment < 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) 


3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
 
# File 'lib/aws-sdk-finspace/types.rb', line 3696

class KxEnvironment < 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) 


3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
 
# File 'lib/aws-sdk-finspace/types.rb', line 3696

class KxEnvironment < 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 unique identifier of the KMS key.

Returns:

  • (String) 


3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
 
# File 'lib/aws-sdk-finspace/types.rb', line 3696

class KxEnvironment < 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) 


3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
 
# File 'lib/aws-sdk-finspace/types.rb', line 3696

class KxEnvironment < 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 environment creation.

  • CREATE_REQUESTED – Environment creation has been requested.

  • CREATING – Environment is in the process of being created.

  • FAILED_CREATION – Environment creation has failed.

  • CREATED – Environment is successfully created and is currently active.

  • DELETE REQUESTED – Environment deletion has been requested.

  • DELETING – Environment is in the process of being deleted.

  • RETRY_DELETION – Initial environment deletion failed, system is reattempting delete.

  • DELETED – Environment has been deleted.

  • FAILED_DELETION – Environment deletion has failed.

Returns:

  • (String) 


3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
 
# File 'lib/aws-sdk-finspace/types.rb', line 3696

class KxEnvironment < 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) 


3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
 
# File 'lib/aws-sdk-finspace/types.rb', line 3696

class KxEnvironment < 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

Specifies the transit gateway and network configuration to connect the kdb environment to an internal network.

Returns:



3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
 
# File 'lib/aws-sdk-finspace/types.rb', line 3696

class KxEnvironment < 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 modified in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

Returns:

  • (Time) 


3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
 
# File 'lib/aws-sdk-finspace/types.rb', line 3696

class KxEnvironment < 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