Skip to content

KxEnvironment

Source code in docs_src/capo_finspace/types/kx_environment.py
class KxEnvironment(TypedDict, closed=True):
    name: NotRequired["capo_finspace.types.kx_environment_name.KxEnvironmentName"]
    """<p>The name of the kdb environment.</p>"""
    environment_id: NotRequired["capo_finspace.types.id_type.IdType"]
    """<p>A unique identifier for the kdb environment.</p>"""
    aws_account_id: NotRequired["capo_finspace.types.id_type.IdType"]
    """<p>The unique identifier of the AWS account in which you create the kdb environment.</p>"""
    status: NotRequired["capo_finspace.types.environment_status.EnvironmentStatus"]
    """<p>The status of the environment creation. </p> <ul> <li> <p>CREATE_REQUESTED – Environment creation has been requested.</p> </li> <li> <p>CREATING – Environment is in the process of being created.</p> </li> <li> <p>FAILED_CREATION – Environment creation has failed.</p> </li> <li> <p>CREATED – Environment is successfully created and is currently active.</p> </li> <li> <p>DELETE REQUESTED – Environment deletion has been requested.</p> </li> <li> <p>DELETING – Environment is in the process of being deleted.</p> </li> <li> <p>RETRY_DELETION – Initial environment deletion failed, system is reattempting delete.</p> </li> <li> <p>DELETED – Environment has been deleted.</p> </li> <li> <p>FAILED_DELETION – Environment deletion has failed.</p> </li> </ul>"""
    tgw_status: NotRequired["capo_finspace.types.tgw_status.tgwStatus"]
    """<p>The status of the network configuration.</p>"""
    dns_status: NotRequired["capo_finspace.types.dns_status.dnsStatus"]
    """<p>The status of DNS configuration.</p>"""
    error_message: NotRequired[
        "capo_finspace.types.environment_error_message.EnvironmentErrorMessage"
    ]
    """<p>Specifies the error message that appears if a flow fails. </p>"""
    description: NotRequired["capo_finspace.types.description.Description"]
    """<p>A description of the kdb environment.</p>"""
    environment_arn: NotRequired["capo_finspace.types.environment_arn.EnvironmentArn"]
    """<p>The Amazon Resource Name (ARN) of your kdb environment.</p>"""
    kms_key_id: NotRequired["capo_finspace.types.kms_key_id.KmsKeyId"]
    """<p>The unique identifier of the KMS key.</p>"""
    dedicated_service_account_id: NotRequired["capo_finspace.types.id_type.IdType"]
    """<p>A unique identifier for the AWS environment infrastructure account.</p>"""
    transit_gateway_configuration: NotRequired[
        "capo_finspace.types.transit_gateway_configuration.TransitGatewayConfiguration"
    ]
    """<p>Specifies the transit gateway and network configuration to connect the kdb environment to an internal network.</p>"""
    custom_dns_configuration: NotRequired[
        "capo_finspace.types.custom_dns_configuration.CustomDNSConfiguration"
    ]
    """<p>A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.</p>"""
    creation_timestamp: NotRequired["capo_finspace.types.timestamp.Timestamp"]
    """<p>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.</p>"""
    update_timestamp: NotRequired["capo_finspace.types.timestamp.Timestamp"]
    """<p>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.</p>"""
    availability_zone_ids: NotRequired[
        "capo_finspace.types.availability_zone_ids.AvailabilityZoneIds"
    ]
    """<p>The identifier of the availability zones where subnets for the environment are created.</p>"""
    certificate_authority_arn: NotRequired[
        "capo_finspace.types.string_value_length1to255.stringValueLength1to255"
    ]
    """<p>The Amazon Resource Name (ARN) of the certificate authority:</p>"""

availability_zone_ids instance-attribute

availability_zone_ids: NotRequired[AvailabilityZoneIds]

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

aws_account_id instance-attribute

aws_account_id: NotRequired[IdType]

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

certificate_authority_arn instance-attribute

certificate_authority_arn: NotRequired[stringValueLength1to255]

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

creation_timestamp instance-attribute

creation_timestamp: NotRequired[Timestamp]

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.

custom_dns_configuration instance-attribute

custom_dns_configuration: NotRequired[CustomDNSConfiguration]

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

dedicated_service_account_id instance-attribute

dedicated_service_account_id: NotRequired[IdType]

A unique identifier for the AWS environment infrastructure account.

description instance-attribute

description: NotRequired[Description]

A description of the kdb environment.

dns_status instance-attribute

dns_status: NotRequired[dnsStatus]

The status of DNS configuration.

environment_arn instance-attribute

environment_arn: NotRequired[EnvironmentArn]

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

environment_id instance-attribute

environment_id: NotRequired[IdType]

A unique identifier for the kdb environment.

error_message instance-attribute

error_message: NotRequired[EnvironmentErrorMessage]

Specifies the error message that appears if a flow fails.

kms_key_id instance-attribute

kms_key_id: NotRequired[KmsKeyId]

The unique identifier of the KMS key.

name instance-attribute

name: NotRequired[KxEnvironmentName]

The name of the kdb environment.

status instance-attribute

status: NotRequired[EnvironmentStatus]

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.

tgw_status instance-attribute

tgw_status: NotRequired[tgwStatus]

The status of the network configuration.

transit_gateway_configuration instance-attribute

transit_gateway_configuration: NotRequired[TransitGatewayConfiguration]

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

update_timestamp instance-attribute

update_timestamp: NotRequired[Timestamp]

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.