Skip to main content

kx_environments

Creates, updates, deletes, gets or lists a kx_environments resource.

Overview​

Namekx_environments
TypeResource
Idaws.finspace.kx_environments

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
namestringThe name of the kdb environment. (pattern: <code>^[a-zA-Z0-9][a-zA-Z0-9-_]*[a-zA-Z0-9]$</code>)
availability_zone_idsarrayThe identifier of the availability zones where subnets for the environment are created.
aws_account_idstringThe unique identifier of the AWS account that is used to create the kdb environment. (pattern: <code>^[a-zA-Z0-9]{1,26}$</code>)
certificate_authority_arnstringThe Amazon Resource Name (ARN) of the certificate authority of the kdb environment.
creation_timestampstring (date-time)The timestamp at which the kdb environment was created in FinSpace.
custom_dns_configurationarrayA list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
dedicated_service_account_idstringA unique identifier for the AWS environment infrastructure account. (pattern: <code>^[a-zA-Z0-9]{1,26}$</code>)
descriptionstringA description for the kdb environment. (pattern: <code>^[a-zA-Z0-9. ]{1,1000}$</code>)
dns_statusstringThe status of DNS configuration. (NONE, UPDATE_REQUESTED, UPDATING, FAILED_UPDATE, SUCCESSFULLY_UPDATED)
environment_arnstringThe ARN identifier of the environment. (pattern: <code>^arn:aws:finspace:[A-Za-z0-9_/.-]{0,63}:\d+:environment/[0-9A-Za-z_-]{1,128}$</code>)
environment_idstringA unique identifier for the kdb environment. (pattern: <code>^[a-zA-Z0-9]{1,26}$</code>)
error_messagestringSpecifies the error message that appears if a flow fails. (pattern: <code>^[a-zA-Z0-9. ]{1,1000}$</code>)
kms_key_idstringThe KMS key ID to encrypt your data in the FinSpace environment. (pattern: <code>^[a-zA-Z-0-9-:/]*$</code>)
statusstringThe status of the kdb environment. (CREATE_REQUESTED, CREATING, CREATED, DELETE_REQUESTED, DELETING, DELETED, FAILED_CREATION, RETRY_DELETION, FAILED_DELETION, UPDATE_NETWORK_REQUESTED, UPDATING_NETWORK, FAILED_UPDATING_NETWORK, SUSPENDED)
tgw_statusstringThe status of the network configuration. (NONE, UPDATE_REQUESTED, UPDATING, FAILED_UPDATE, SUCCESSFULLY_UPDATED)
transit_gateway_configurationobjectThe structure of the transit gateway and network configuration that is used to connect the kdb environment to an internal network.
update_timestampstring (date-time)The timestamp at which the kdb environment was updated.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_kx_environmentselectenvironment_id, regionRetrieves all the information for the specified kdb environment.
list_kx_environmentsselectregionnextToken, maxResultsReturns a list of kdb environments created in an account.
create_kx_environmentinsertregion, name, kmsKeyIdCreates a managed kdb environment for the account.
update_kx_environmentupdateenvironment_id, regionUpdates information for the given kdb environment.
delete_kx_environmentdeleteenvironment_id, regionclientTokenDeletes the kdb environment. This action is irreversible. Deleting a kdb environment will remove all the associated data and any services running in it.
update_kx_environment_networkexecenvironment_id, regionUpdates environment network to connect to your internal network by using a transit gateway. This API supports request to create a transit gateway attachment from FinSpace VPC to your transit gateway ID and create a custom Route-53 outbound resolvers. Once you send a request to update a network, you cannot change it again. Network update might require termination of any clusters that are running in the existing network.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
environment_idstringA unique identifier for the kdb environment.
regionstringAWS region (default: us-east-1)
clientTokenstringA token that ensures idempotency. This token expires in 10 minutes.
maxResultsintegerThe maximum number of results to return in this request.
nextTokenstringA token that indicates where a results page should begin.

SELECT examples​

Retrieves all the information for the specified kdb environment.

SELECT
name,
availability_zone_ids,
aws_account_id,
certificate_authority_arn,
creation_timestamp,
custom_dns_configuration,
dedicated_service_account_id,
description,
dns_status,
environment_arn,
environment_id,
error_message,
kms_key_id,
status,
tgw_status,
transit_gateway_configuration,
update_timestamp
FROM aws.finspace.kx_environments
WHERE environment_id = '{{ environment_id }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples​

Creates a managed kdb environment for the account.

INSERT INTO aws.finspace.kx_environments (
name,
description,
kmsKeyId,
tags,
clientToken,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ description }}',
'{{ kmsKeyId }}' /* required */,
'{{ tags }}',
'{{ clientToken }}',
'{{ region }}'
RETURNING
name,
creation_timestamp,
description,
environment_arn,
environment_id,
kms_key_id,
status
;

UPDATE examples​

Updates information for the given kdb environment.

UPDATE aws.finspace.kx_environments
SET 
name = '{{ name }}',
description = '{{ description }}',
clientToken = '{{ clientToken }}'
WHERE 
environment_id = '{{ environment_id }}' --required
AND region = '{{ region }}' --required
RETURNING
name,
availability_zone_ids,
aws_account_id,
creation_timestamp,
custom_dns_configuration,
dedicated_service_account_id,
description,
dns_status,
environment_arn,
environment_id,
error_message,
kms_key_id,
status,
tgw_status,
transit_gateway_configuration,
update_timestamp;

DELETE examples​

Deletes the kdb environment. This action is irreversible. Deleting a kdb environment will remove all the associated data and any services running in it.

DELETE FROM aws.finspace.kx_environments
WHERE environment_id = '{{ environment_id }}' --required
AND region = '{{ region }}' --required
AND clientToken = '{{ clientToken }}'
;

Lifecycle Methods​

Updates environment network to connect to your internal network by using a transit gateway. This API supports request to create a transit gateway attachment from FinSpace VPC to your transit gateway ID and create a custom Route-53 outbound resolvers. Once you send a request to update a network, you cannot change it again. Network update might require termination of any clusters that are running in the existing network.

EXEC aws.finspace.kx_environments.update_kx_environment_network 
@environment_id='{{ environment_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"transitGatewayConfiguration": "{{ transitGatewayConfiguration }}", 
"customDNSConfiguration": "{{ customDNSConfiguration }}", 
"clientToken": "{{ clientToken }}"
}'
;
Last updated on