KxEnvironment

The details of a kdb environment.

Note

In the following list, the required parameters are described first.

availabilityZoneIds

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

Type: Array of strings

Length Constraints: Minimum length of 8. Maximum length of 12.

Pattern: ^[a-zA-Z0-9-]+$

Required: No

awsAccountId

The unique identifier of the AWS account in which you create the kdb environment.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 26.

Pattern: ^[a-zA-Z0-9]{1,26}$

Required: No

certificateAuthorityArn

The Amazon Resource Name (ARN) of the certificate authority:

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

creationTimestamp

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.

Type: Timestamp

Required: No

customDNSConfiguration

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

Type: Array of CustomDNSServer objects

Required: No

dedicatedServiceAccountId

A unique identifier for the AWS environment infrastructure account.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 26.

Pattern: ^[a-zA-Z0-9]{1,26}$

Required: No

description

A description of the kdb environment.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1000.

Pattern: ^[a-zA-Z0-9. ]{1,1000}$

Required: No

dnsStatus

The status of DNS configuration.

Type: String

Valid Values: NONE | UPDATE_REQUESTED | UPDATING | FAILED_UPDATE | SUCCESSFULLY_UPDATED

Required: No

environmentArn

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:aws:finspace:[A-Za-z0-9_/.-]{0,63}:\d+:environment/[0-9A-Za-z_-]{1,128}$

Required: No

environmentId

A unique identifier for the kdb environment.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 26.

Pattern: ^[a-zA-Z0-9]{1,26}$

Required: No

errorMessage

Specifies the error message that appears if a flow fails.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1000.

Pattern: ^[a-zA-Z0-9. ]{1,1000}$

Required: No

kmsKeyId

The unique identifier of the KMS key.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1000.

Pattern: ^[a-zA-Z-0-9-:\/]*$

Required: No

name

The name of the kdb environment.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 63.

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_]*[a-zA-Z0-9]$

Required: No

status

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.

Type: String

Required: No

tgwStatus

The status of the network configuration.

Type: String

Valid Values: NONE | UPDATE_REQUESTED | UPDATING | FAILED_UPDATE | SUCCESSFULLY_UPDATED

Required: No

transitGatewayConfiguration

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

Type: TransitGatewayConfiguration object

Required: No

updateTimestamp

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.

Type: Timestamp

Required: No

KxEnvironment

Contents

Note

See Also