Skip to content

Finspace Classes

AutoScalingConfiguration

minNodeCount

  • Type: typing.Optional[int]

maxNodeCount

  • Type: typing.Optional[int]

autoScalingMetric

  • Type: typing.Optional[typing.Literal['CPU_UTILIZATION_PERCENTAGE']]

metricTarget

  • Type: typing.Optional[float]

scaleInCooldownSeconds

  • Type: typing.Optional[float]

scaleOutCooldownSeconds

  • Type: typing.Optional[float]

BaseValidatorModel

Oops! This Pydantic model is currently empty. Stay tuned!

CapacityConfiguration

nodeType

  • Type: typing.Optional[str]

nodeCount

  • Type: typing.Optional[int]

ChangeRequest

changeType

  • Type: typing.Literal['DELETE', 'PUT']
  • Required: Yes

dbPath

  • Type:
  • Required: Yes

s3Path

  • Type: typing.Optional[str]

CodeConfiguration

s3Bucket

  • Type: typing.Optional[str]

s3Key

  • Type: typing.Optional[str]

s3ObjectVersion

  • Type: typing.Optional[str]

CreateEnvironmentRequest

name

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

kmsKeyId

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

federationMode

  • Type: typing.Optional[typing.Literal['FEDERATED', 'LOCAL']]

federationParameters

  • Type: typing.Union[aws_resource_validator.pydantic_models.finspace.finspace_classes.FederationParameters, aws_resource_validator.pydantic_models.finspace.finspace_classes.FederationParametersOutput, NoneType]

superuserParameters

  • Type: typing.Optional[aws_resource_validator.pydantic_models.finspace.finspace_classes.SuperuserParameters]

dataBundles

  • Type: typing.Optional[typing.List[str]]

CreateEnvironmentResponse

environmentId

  • Type:
  • Required: Yes

environmentArn

  • Type:
  • Required: Yes

environmentUrl

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateKxChangesetRequest

environmentId

  • Type:
  • Required: Yes

databaseName

  • Type:
  • Required: Yes

changeRequests

  • Type: typing.List[aws_resource_validator.pydantic_models.finspace.finspace_classes.ChangeRequest]
  • Required: Yes

clientToken

  • Type:
  • Required: Yes

CreateKxChangesetResponse

changesetId

  • Type:
  • Required: Yes

databaseName

  • Type:
  • Required: Yes

environmentId

  • Type:
  • Required: Yes

changeRequests

  • Type: typing.List[aws_resource_validator.pydantic_models.finspace.finspace_classes.ChangeRequest]
  • Required: Yes

createdTimestamp

  • Type:
  • Required: Yes

lastModifiedTimestamp

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['COMPLETED', 'FAILED', 'PENDING', 'PROCESSING']
  • Required: Yes

errorInfo

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateKxClusterRequest

environmentId

  • Type:
  • Required: Yes

clusterName

  • Type:
  • Required: Yes

clusterType

  • Type: typing.Literal['GATEWAY', 'GP', 'HDB', 'RDB', 'TICKERPLANT']
  • Required: Yes

releaseLabel

  • Type:
  • Required: Yes

vpcConfiguration

  • Type: typing.Union[aws_resource_validator.pydantic_models.finspace.finspace_classes.VpcConfiguration, aws_resource_validator.pydantic_models.finspace.finspace_classes.VpcConfigurationOutput]
  • Required: Yes

azMode

  • Type: typing.Literal['MULTI', 'SINGLE']
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

tickerplantLogConfiguration

  • Type: typing.Union[aws_resource_validator.pydantic_models.finspace.finspace_classes.TickerplantLogConfiguration, aws_resource_validator.pydantic_models.finspace.finspace_classes.TickerplantLogConfigurationOutput, NoneType]

databases

  • Type: typing.Optional[typing.List[typing.Union[aws_resource_validator.pydantic_models.finspace.finspace_classes.KxDatabaseConfiguration, aws_resource_validator.pydantic_models.finspace.finspace_classes.KxDatabaseConfigurationOutput]]]

cacheStorageConfigurations

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.finspace.finspace_classes.KxCacheStorageConfiguration]]

autoScalingConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.finspace.finspace_classes.AutoScalingConfiguration]

clusterDescription

  • Type: typing.Optional[str]

capacityConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.finspace.finspace_classes.CapacityConfiguration]

initializationScript

  • Type: typing.Optional[str]

commandLineArguments

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.finspace.finspace_classes.KxCommandLineArgument]]

code

  • Type: typing.Optional[aws_resource_validator.pydantic_models.finspace.finspace_classes.CodeConfiguration]

executionRole

  • Type: typing.Optional[str]

savedownStorageConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.finspace.finspace_classes.KxSavedownStorageConfiguration]

availabilityZoneId

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

scalingGroupConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.finspace.finspace_classes.KxScalingGroupConfiguration]

CreateKxClusterResponse

environmentId

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['CREATE_FAILED', 'CREATING', 'DELETED', 'DELETE_FAILED', 'DELETING', 'PENDING', 'RUNNING', 'UPDATING']
  • Required: Yes

statusReason

  • Type:
  • Required: Yes

clusterName

  • Type:
  • Required: Yes

clusterType

  • Type: typing.Literal['GATEWAY', 'GP', 'HDB', 'RDB', 'TICKERPLANT']
  • Required: Yes

tickerplantLogConfiguration

  • Type:
  • Required: Yes

volumes

  • Type: typing.List[aws_resource_validator.pydantic_models.finspace.finspace_classes.Volume]
  • Required: Yes

databases

  • Type: typing.List[aws_resource_validator.pydantic_models.finspace.finspace_classes.KxDatabaseConfigurationOutput]
  • Required: Yes

cacheStorageConfigurations

  • Type: typing.List[aws_resource_validator.pydantic_models.finspace.finspace_classes.KxCacheStorageConfiguration]
  • Required: Yes

autoScalingConfiguration

  • Type:
  • Required: Yes

clusterDescription

  • Type:
  • Required: Yes

capacityConfiguration

  • Type:
  • Required: Yes

releaseLabel

  • Type:
  • Required: Yes

vpcConfiguration

  • Type:
  • Required: Yes

initializationScript

  • Type:
  • Required: Yes

commandLineArguments

  • Type: typing.List[aws_resource_validator.pydantic_models.finspace.finspace_classes.KxCommandLineArgument]
  • Required: Yes

code

  • Type:
  • Required: Yes

executionRole

  • Type:
  • Required: Yes

lastModifiedTimestamp

  • Type:
  • Required: Yes

savedownStorageConfiguration

  • Type:
  • Required: Yes

azMode

  • Type: typing.Literal['MULTI', 'SINGLE']
  • Required: Yes

availabilityZoneId

  • Type:
  • Required: Yes

createdTimestamp

  • Type:
  • Required: Yes

scalingGroupConfiguration

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateKxDatabaseRequest

environmentId

  • Type:
  • Required: Yes

databaseName

  • Type:
  • Required: Yes

clientToken

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

CreateKxDatabaseResponse

databaseName

  • Type:
  • Required: Yes

databaseArn

  • Type:
  • Required: Yes

environmentId

  • Type:
  • Required: Yes

description

  • Type:
  • Required: Yes

createdTimestamp

  • Type:
  • Required: Yes

lastModifiedTimestamp

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateKxDataviewRequest

environmentId

  • Type:
  • Required: Yes

databaseName

  • Type:
  • Required: Yes

dataviewName

  • Type:
  • Required: Yes

azMode

  • Type: typing.Literal['MULTI', 'SINGLE']
  • Required: Yes

clientToken

  • Type:
  • Required: Yes

availabilityZoneId

  • Type: typing.Optional[str]

changesetId

  • Type: typing.Optional[str]

segmentConfigurations

  • Type: typing.Optional[typing.List[typing.Union[aws_resource_validator.pydantic_models.finspace.finspace_classes.KxDataviewSegmentConfiguration, aws_resource_validator.pydantic_models.finspace.finspace_classes.KxDataviewSegmentConfigurationOutput]]]

autoUpdate

  • Type: typing.Optional[bool]

readWrite

  • Type: typing.Optional[bool]

description

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

CreateKxDataviewResponse

dataviewName

  • Type:
  • Required: Yes

databaseName

  • Type:
  • Required: Yes

environmentId

  • Type:
  • Required: Yes

azMode

  • Type: typing.Literal['MULTI', 'SINGLE']
  • Required: Yes

availabilityZoneId

  • Type:
  • Required: Yes

changesetId

  • Type:
  • Required: Yes

segmentConfigurations

  • Type: typing.List[aws_resource_validator.pydantic_models.finspace.finspace_classes.KxDataviewSegmentConfigurationOutput]
  • Required: Yes

description

  • Type:
  • Required: Yes

autoUpdate

  • Type:
  • Required: Yes

readWrite

  • Type:
  • Required: Yes

createdTimestamp

  • Type:
  • Required: Yes

lastModifiedTimestamp

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['ACTIVE', 'CREATING', 'DELETING', 'FAILED', 'UPDATING']
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateKxEnvironmentRequest

name

  • Type:
  • Required: Yes

kmsKeyId

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

clientToken

  • Type: typing.Optional[str]

CreateKxEnvironmentResponse

name

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['CREATED', 'CREATE_REQUESTED', 'CREATING', 'DELETED', 'DELETE_REQUESTED', 'DELETING', 'FAILED_CREATION', 'FAILED_DELETION', 'FAILED_UPDATING_NETWORK', 'RETRY_DELETION', 'SUSPENDED', 'UPDATE_NETWORK_REQUESTED', 'UPDATING_NETWORK']
  • Required: Yes

environmentId

  • Type:
  • Required: Yes

description

  • Type:
  • Required: Yes

environmentArn

  • Type:
  • Required: Yes

kmsKeyId

  • Type:
  • Required: Yes

creationTimestamp

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateKxScalingGroupRequest

clientToken

  • Type:
  • Required: Yes

environmentId

  • Type:
  • Required: Yes

scalingGroupName

  • Type:
  • Required: Yes

hostType

  • Type:
  • Required: Yes

availabilityZoneId

  • Type:
  • Required: Yes

tags

  • Type: typing.Optional[typing.Dict[str, str]]

CreateKxScalingGroupResponse

environmentId

  • Type:
  • Required: Yes

scalingGroupName

  • Type:
  • Required: Yes

hostType

  • Type:
  • Required: Yes

availabilityZoneId

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['ACTIVE', 'CREATE_FAILED', 'CREATING', 'DELETED', 'DELETE_FAILED', 'DELETING']
  • Required: Yes

lastModifiedTimestamp

  • Type:
  • Required: Yes

createdTimestamp

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateKxUserRequest

environmentId

  • Type:
  • Required: Yes

userName

  • Type:
  • Required: Yes

iamRole

  • Type:
  • Required: Yes

tags

  • Type: typing.Optional[typing.Dict[str, str]]

clientToken

  • Type: typing.Optional[str]

CreateKxUserResponse

userName

  • Type:
  • Required: Yes

userArn

  • Type:
  • Required: Yes

environmentId

  • Type:
  • Required: Yes

iamRole

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateKxVolumeRequest

environmentId

  • Type:
  • Required: Yes

volumeType

  • Type: typing.Literal['NAS_1']
  • Required: Yes

volumeName

  • Type:
  • Required: Yes

azMode

  • Type: typing.Literal['MULTI', 'SINGLE']
  • Required: Yes

availabilityZoneIds

  • Type: typing.List[str]
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

nas1Configuration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.finspace.finspace_classes.KxNAS1Configuration]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

CreateKxVolumeResponse

environmentId

  • Type:
  • Required: Yes

volumeName

  • Type:
  • Required: Yes

volumeType

  • Type: typing.Literal['NAS_1']
  • Required: Yes

volumeArn

  • Type:
  • Required: Yes

nas1Configuration

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['ACTIVE', 'CREATE_FAILED', 'CREATING', 'DELETED', 'DELETE_FAILED', 'DELETING', 'UPDATED', 'UPDATE_FAILED', 'UPDATING']
  • Required: Yes

statusReason

  • Type:
  • Required: Yes

azMode

  • Type: typing.Literal['MULTI', 'SINGLE']
  • Required: Yes

description

  • Type:
  • Required: Yes

availabilityZoneIds

  • Type: typing.List[str]
  • Required: Yes

createdTimestamp

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CustomDNSServer

customDNSServerName

  • Type:
  • Required: Yes

customDNSServerIP

  • Type:
  • Required: Yes

DeleteEnvironmentRequest

environmentId

  • Type:
  • Required: Yes

DeleteKxClusterNodeRequest

environmentId

  • Type:
  • Required: Yes

clusterName

  • Type:
  • Required: Yes

nodeId

  • Type:
  • Required: Yes

DeleteKxClusterRequest

environmentId

  • Type:
  • Required: Yes

clusterName

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

DeleteKxDatabaseRequest

environmentId

  • Type:
  • Required: Yes

databaseName

  • Type:
  • Required: Yes

clientToken

  • Type:
  • Required: Yes

DeleteKxDataviewRequest

environmentId

  • Type:
  • Required: Yes

databaseName

  • Type:
  • Required: Yes

dataviewName

  • Type:
  • Required: Yes

clientToken

  • Type:
  • Required: Yes

DeleteKxEnvironmentRequest

environmentId

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

DeleteKxScalingGroupRequest

environmentId

  • Type:
  • Required: Yes

scalingGroupName

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

DeleteKxUserRequest

userName

  • Type:
  • Required: Yes

environmentId

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

DeleteKxVolumeRequest

environmentId

  • Type:
  • Required: Yes

volumeName

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

Environment

name

  • Type: typing.Optional[str]

environmentId

  • Type: typing.Optional[str]

awsAccountId

  • Type: typing.Optional[str]

status

  • Type: typing.Optional[typing.Literal['CREATED', 'CREATE_REQUESTED', 'CREATING', 'DELETED', 'DELETE_REQUESTED', 'DELETING', 'FAILED_CREATION', 'FAILED_DELETION', 'FAILED_UPDATING_NETWORK', 'RETRY_DELETION', 'SUSPENDED', 'UPDATE_NETWORK_REQUESTED', 'UPDATING_NETWORK']]

environmentUrl

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

environmentArn

  • Type: typing.Optional[str]

sageMakerStudioDomainUrl

  • Type: typing.Optional[str]

kmsKeyId

  • Type: typing.Optional[str]

dedicatedServiceAccountId

  • Type: typing.Optional[str]

federationMode

  • Type: typing.Optional[typing.Literal['FEDERATED', 'LOCAL']]

federationParameters

  • Type: typing.Optional[aws_resource_validator.pydantic_models.finspace.finspace_classes.FederationParametersOutput]

ErrorInfo

errorMessage

  • Type: typing.Optional[str]

errorType

  • Type: typing.Optional[typing.Literal['A user recoverable error has occurred', 'An internal error has occurred.', 'Cancelled', 'Missing required permission to perform this request.', 'One or more inputs to this request were not found.', 'Service limits have been exceeded.', 'The inputs to this request are invalid.', 'The system temporarily lacks sufficient resources to process the request.']]

FederationParameters

samlMetadataDocument

  • Type: typing.Optional[str]

samlMetadataURL

  • Type: typing.Optional[str]

applicationCallBackURL

  • Type: typing.Optional[str]

federationURN

  • Type: typing.Optional[str]

federationProviderName

  • Type: typing.Optional[str]

attributeMap

  • Type: typing.Optional[typing.Dict[str, str]]

FederationParametersOutput

samlMetadataDocument

  • Type: typing.Optional[str]

samlMetadataURL

  • Type: typing.Optional[str]

applicationCallBackURL

  • Type: typing.Optional[str]

federationURN

  • Type: typing.Optional[str]

federationProviderName

  • Type: typing.Optional[str]

attributeMap

  • Type: typing.Optional[typing.Dict[str, str]]

GetEnvironmentRequest

environmentId

  • Type:
  • Required: Yes

GetEnvironmentResponse

environment

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetKxChangesetRequest

environmentId

  • Type:
  • Required: Yes

databaseName

  • Type:
  • Required: Yes

changesetId

  • Type:
  • Required: Yes

GetKxChangesetResponse

changesetId

  • Type:
  • Required: Yes

databaseName

  • Type:
  • Required: Yes

environmentId

  • Type:
  • Required: Yes

changeRequests

  • Type: typing.List[aws_resource_validator.pydantic_models.finspace.finspace_classes.ChangeRequest]
  • Required: Yes

createdTimestamp

  • Type:
  • Required: Yes

activeFromTimestamp

  • Type:
  • Required: Yes

lastModifiedTimestamp

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['COMPLETED', 'FAILED', 'PENDING', 'PROCESSING']
  • Required: Yes

errorInfo

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetKxClusterRequest

environmentId

  • Type:
  • Required: Yes

clusterName

  • Type:
  • Required: Yes

GetKxClusterResponse

status

  • Type: typing.Literal['CREATE_FAILED', 'CREATING', 'DELETED', 'DELETE_FAILED', 'DELETING', 'PENDING', 'RUNNING', 'UPDATING']
  • Required: Yes

statusReason

  • Type:
  • Required: Yes

clusterName

  • Type:
  • Required: Yes

clusterType

  • Type: typing.Literal['GATEWAY', 'GP', 'HDB', 'RDB', 'TICKERPLANT']
  • Required: Yes

tickerplantLogConfiguration

  • Type:
  • Required: Yes

volumes

  • Type: typing.List[aws_resource_validator.pydantic_models.finspace.finspace_classes.Volume]
  • Required: Yes

databases

  • Type: typing.List[aws_resource_validator.pydantic_models.finspace.finspace_classes.KxDatabaseConfigurationOutput]
  • Required: Yes

cacheStorageConfigurations

  • Type: typing.List[aws_resource_validator.pydantic_models.finspace.finspace_classes.KxCacheStorageConfiguration]
  • Required: Yes

autoScalingConfiguration

  • Type:
  • Required: Yes

clusterDescription

  • Type:
  • Required: Yes

capacityConfiguration

  • Type:
  • Required: Yes

releaseLabel

  • Type:
  • Required: Yes

vpcConfiguration

  • Type:
  • Required: Yes

initializationScript

  • Type:
  • Required: Yes

commandLineArguments

  • Type: typing.List[aws_resource_validator.pydantic_models.finspace.finspace_classes.KxCommandLineArgument]
  • Required: Yes

code

  • Type:
  • Required: Yes

executionRole

  • Type:
  • Required: Yes

lastModifiedTimestamp

  • Type:
  • Required: Yes

savedownStorageConfiguration

  • Type:
  • Required: Yes

azMode

  • Type: typing.Literal['MULTI', 'SINGLE']
  • Required: Yes

availabilityZoneId

  • Type:
  • Required: Yes

createdTimestamp

  • Type:
  • Required: Yes

scalingGroupConfiguration

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetKxConnectionStringRequest

userArn

  • Type:
  • Required: Yes

environmentId

  • Type:
  • Required: Yes

clusterName

  • Type:
  • Required: Yes

GetKxConnectionStringResponse

signedConnectionString

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetKxDatabaseRequest

environmentId

  • Type:
  • Required: Yes

databaseName

  • Type:
  • Required: Yes

GetKxDatabaseResponse

databaseName

  • Type:
  • Required: Yes

databaseArn

  • Type:
  • Required: Yes

environmentId

  • Type:
  • Required: Yes

description

  • Type:
  • Required: Yes

createdTimestamp

  • Type:
  • Required: Yes

lastModifiedTimestamp

  • Type:
  • Required: Yes

lastCompletedChangesetId

  • Type:
  • Required: Yes

numBytes

  • Type:
  • Required: Yes

numChangesets

  • Type:
  • Required: Yes

numFiles

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetKxDataviewRequest

environmentId

  • Type:
  • Required: Yes

databaseName

  • Type:
  • Required: Yes

dataviewName

  • Type:
  • Required: Yes

GetKxDataviewResponse

databaseName

  • Type:
  • Required: Yes

dataviewName

  • Type:
  • Required: Yes

azMode

  • Type: typing.Literal['MULTI', 'SINGLE']
  • Required: Yes

availabilityZoneId

  • Type:
  • Required: Yes

changesetId

  • Type:
  • Required: Yes

segmentConfigurations

  • Type: typing.List[aws_resource_validator.pydantic_models.finspace.finspace_classes.KxDataviewSegmentConfigurationOutput]
  • Required: Yes

activeVersions

  • Type: typing.List[aws_resource_validator.pydantic_models.finspace.finspace_classes.KxDataviewActiveVersion]
  • Required: Yes

description

  • Type:
  • Required: Yes

autoUpdate

  • Type:
  • Required: Yes

readWrite

  • Type:
  • Required: Yes

environmentId

  • Type:
  • Required: Yes

createdTimestamp

  • Type:
  • Required: Yes

lastModifiedTimestamp

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['ACTIVE', 'CREATING', 'DELETING', 'FAILED', 'UPDATING']
  • Required: Yes

statusReason

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetKxEnvironmentRequest

environmentId

  • Type:
  • Required: Yes

GetKxEnvironmentResponse

name

  • Type:
  • Required: Yes

environmentId

  • Type:
  • Required: Yes

awsAccountId

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['CREATED', 'CREATE_REQUESTED', 'CREATING', 'DELETED', 'DELETE_REQUESTED', 'DELETING', 'FAILED_CREATION', 'FAILED_DELETION', 'FAILED_UPDATING_NETWORK', 'RETRY_DELETION', 'SUSPENDED', 'UPDATE_NETWORK_REQUESTED', 'UPDATING_NETWORK']
  • Required: Yes

tgwStatus

  • Type: typing.Literal['FAILED_UPDATE', 'NONE', 'SUCCESSFULLY_UPDATED', 'UPDATE_REQUESTED', 'UPDATING']
  • Required: Yes

dnsStatus

  • Type: typing.Literal['FAILED_UPDATE', 'NONE', 'SUCCESSFULLY_UPDATED', 'UPDATE_REQUESTED', 'UPDATING']
  • Required: Yes

errorMessage

  • Type:
  • Required: Yes

description

  • Type:
  • Required: Yes

environmentArn

  • Type:
  • Required: Yes

kmsKeyId

  • Type:
  • Required: Yes

dedicatedServiceAccountId

  • Type:
  • Required: Yes

transitGatewayConfiguration

  • Type:
  • Required: Yes

customDNSConfiguration

  • Type: typing.List[aws_resource_validator.pydantic_models.finspace.finspace_classes.CustomDNSServer]
  • Required: Yes

creationTimestamp

  • Type:
  • Required: Yes

updateTimestamp

  • Type:
  • Required: Yes

availabilityZoneIds

  • Type: typing.List[str]
  • Required: Yes

certificateAuthorityArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetKxScalingGroupRequest

environmentId

  • Type:
  • Required: Yes

scalingGroupName

  • Type:
  • Required: Yes

GetKxScalingGroupResponse

scalingGroupName

  • Type:
  • Required: Yes

scalingGroupArn

  • Type:
  • Required: Yes

hostType

  • Type:
  • Required: Yes

clusters

  • Type: typing.List[str]
  • Required: Yes

availabilityZoneId

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['ACTIVE', 'CREATE_FAILED', 'CREATING', 'DELETED', 'DELETE_FAILED', 'DELETING']
  • Required: Yes

statusReason

  • Type:
  • Required: Yes

lastModifiedTimestamp

  • Type:
  • Required: Yes

createdTimestamp

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetKxUserRequest

userName

  • Type:
  • Required: Yes

environmentId

  • Type:
  • Required: Yes

GetKxUserResponse

userName

  • Type:
  • Required: Yes

userArn

  • Type:
  • Required: Yes

environmentId

  • Type:
  • Required: Yes

iamRole

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetKxVolumeRequest

environmentId

  • Type:
  • Required: Yes

volumeName

  • Type:
  • Required: Yes

GetKxVolumeResponse

environmentId

  • Type:
  • Required: Yes

volumeName

  • Type:
  • Required: Yes

volumeType

  • Type: typing.Literal['NAS_1']
  • Required: Yes

volumeArn

  • Type:
  • Required: Yes

nas1Configuration

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['ACTIVE', 'CREATE_FAILED', 'CREATING', 'DELETED', 'DELETE_FAILED', 'DELETING', 'UPDATED', 'UPDATE_FAILED', 'UPDATING']
  • Required: Yes

statusReason

  • Type:
  • Required: Yes

createdTimestamp

  • Type:
  • Required: Yes

description

  • Type:
  • Required: Yes

azMode

  • Type: typing.Literal['MULTI', 'SINGLE']
  • Required: Yes

availabilityZoneIds

  • Type: typing.List[str]
  • Required: Yes

lastModifiedTimestamp

  • Type:
  • Required: Yes

attachedClusters

  • Type: typing.List[aws_resource_validator.pydantic_models.finspace.finspace_classes.KxAttachedCluster]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

IcmpTypeCode

type

  • Type:
  • Required: Yes

code

  • Type:
  • Required: Yes

KxAttachedCluster

clusterName

  • Type: typing.Optional[str]

clusterType

  • Type: typing.Optional[typing.Literal['GATEWAY', 'GP', 'HDB', 'RDB', 'TICKERPLANT']]

clusterStatus

  • Type: typing.Optional[typing.Literal['CREATE_FAILED', 'CREATING', 'DELETED', 'DELETE_FAILED', 'DELETING', 'PENDING', 'RUNNING', 'UPDATING']]

KxCacheStorageConfiguration

type

  • Type:
  • Required: Yes

size

  • Type:
  • Required: Yes

KxChangesetListEntry

changesetId

  • Type: typing.Optional[str]

createdTimestamp

  • Type: typing.Optional[datetime.datetime]

activeFromTimestamp

  • Type: typing.Optional[datetime.datetime]

lastModifiedTimestamp

  • Type: typing.Optional[datetime.datetime]

status

  • Type: typing.Optional[typing.Literal['COMPLETED', 'FAILED', 'PENDING', 'PROCESSING']]

KxCluster

status

  • Type: typing.Optional[typing.Literal['CREATE_FAILED', 'CREATING', 'DELETED', 'DELETE_FAILED', 'DELETING', 'PENDING', 'RUNNING', 'UPDATING']]

statusReason

  • Type: typing.Optional[str]

clusterName

  • Type: typing.Optional[str]

clusterType

  • Type: typing.Optional[typing.Literal['GATEWAY', 'GP', 'HDB', 'RDB', 'TICKERPLANT']]

clusterDescription

  • Type: typing.Optional[str]

releaseLabel

  • Type: typing.Optional[str]

volumes

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.finspace.finspace_classes.Volume]]

initializationScript

  • Type: typing.Optional[str]

executionRole

  • Type: typing.Optional[str]

azMode

  • Type: typing.Optional[typing.Literal['MULTI', 'SINGLE']]

availabilityZoneId

  • Type: typing.Optional[str]

lastModifiedTimestamp

  • Type: typing.Optional[datetime.datetime]

createdTimestamp

  • Type: typing.Optional[datetime.datetime]

KxClusterCodeDeploymentConfiguration

deploymentStrategy

  • Type: typing.Literal['FORCE', 'NO_RESTART', 'ROLLING']
  • Required: Yes

KxCommandLineArgument

key

  • Type: typing.Optional[str]

value

  • Type: typing.Optional[str]

KxDatabaseCacheConfiguration

cacheType

  • Type:
  • Required: Yes

dbPaths

  • Type: typing.List[str]
  • Required: Yes

dataviewName

  • Type: typing.Optional[str]

KxDatabaseCacheConfigurationOutput

cacheType

  • Type:
  • Required: Yes

dbPaths

  • Type: typing.List[str]
  • Required: Yes

dataviewName

  • Type: typing.Optional[str]

KxDatabaseConfiguration

databaseName

  • Type:
  • Required: Yes

cacheConfigurations

  • Type: typing.Optional[typing.List[typing.Union[aws_resource_validator.pydantic_models.finspace.finspace_classes.KxDatabaseCacheConfiguration, aws_resource_validator.pydantic_models.finspace.finspace_classes.KxDatabaseCacheConfigurationOutput]]]

changesetId

  • Type: typing.Optional[str]

dataviewName

  • Type: typing.Optional[str]

dataviewConfiguration

  • Type: typing.Union[aws_resource_validator.pydantic_models.finspace.finspace_classes.KxDataviewConfiguration, aws_resource_validator.pydantic_models.finspace.finspace_classes.KxDataviewConfigurationOutput, NoneType]

KxDatabaseConfigurationOutput

databaseName

  • Type:
  • Required: Yes

cacheConfigurations

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.finspace.finspace_classes.KxDatabaseCacheConfigurationOutput]]

changesetId

  • Type: typing.Optional[str]

dataviewName

  • Type: typing.Optional[str]

dataviewConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.finspace.finspace_classes.KxDataviewConfigurationOutput]

KxDatabaseListEntry

databaseName

  • Type: typing.Optional[str]

createdTimestamp

  • Type: typing.Optional[datetime.datetime]

lastModifiedTimestamp

  • Type: typing.Optional[datetime.datetime]

KxDataviewActiveVersion

changesetId

  • Type: typing.Optional[str]

segmentConfigurations

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.finspace.finspace_classes.KxDataviewSegmentConfigurationOutput]]

attachedClusters

  • Type: typing.Optional[typing.List[str]]

createdTimestamp

  • Type: typing.Optional[datetime.datetime]

versionId

  • Type: typing.Optional[str]

KxDataviewConfiguration

dataviewName

  • Type: typing.Optional[str]

dataviewVersionId

  • Type: typing.Optional[str]

changesetId

  • Type: typing.Optional[str]

segmentConfigurations

  • Type: typing.Optional[typing.List[typing.Union[aws_resource_validator.pydantic_models.finspace.finspace_classes.KxDataviewSegmentConfiguration, aws_resource_validator.pydantic_models.finspace.finspace_classes.KxDataviewSegmentConfigurationOutput]]]

KxDataviewConfigurationOutput

dataviewName

  • Type: typing.Optional[str]

dataviewVersionId

  • Type: typing.Optional[str]

changesetId

  • Type: typing.Optional[str]

segmentConfigurations

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.finspace.finspace_classes.KxDataviewSegmentConfigurationOutput]]

KxDataviewListEntry

environmentId

  • Type: typing.Optional[str]

databaseName

  • Type: typing.Optional[str]

dataviewName

  • Type: typing.Optional[str]

azMode

  • Type: typing.Optional[typing.Literal['MULTI', 'SINGLE']]

availabilityZoneId

  • Type: typing.Optional[str]

changesetId

  • Type: typing.Optional[str]

segmentConfigurations

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.finspace.finspace_classes.KxDataviewSegmentConfigurationOutput]]

activeVersions

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.finspace.finspace_classes.KxDataviewActiveVersion]]

status

  • Type: typing.Optional[typing.Literal['ACTIVE', 'CREATING', 'DELETING', 'FAILED', 'UPDATING']]

description

  • Type: typing.Optional[str]

autoUpdate

  • Type: typing.Optional[bool]

readWrite

  • Type: typing.Optional[bool]

createdTimestamp

  • Type: typing.Optional[datetime.datetime]

lastModifiedTimestamp

  • Type: typing.Optional[datetime.datetime]

statusReason

  • Type: typing.Optional[str]

KxDataviewSegmentConfiguration

dbPaths

  • Type: typing.List[str]
  • Required: Yes

volumeName

  • Type:
  • Required: Yes

onDemand

  • Type: typing.Optional[bool]

KxDataviewSegmentConfigurationOutput

dbPaths

  • Type: typing.List[str]
  • Required: Yes

volumeName

  • Type:
  • Required: Yes

onDemand

  • Type: typing.Optional[bool]

KxDeploymentConfiguration

deploymentStrategy

  • Type: typing.Literal['NO_RESTART', 'ROLLING']
  • Required: Yes

KxEnvironment

name

  • Type: typing.Optional[str]

environmentId

  • Type: typing.Optional[str]

awsAccountId

  • Type: typing.Optional[str]

status

  • Type: typing.Optional[typing.Literal['CREATED', 'CREATE_REQUESTED', 'CREATING', 'DELETED', 'DELETE_REQUESTED', 'DELETING', 'FAILED_CREATION', 'FAILED_DELETION', 'FAILED_UPDATING_NETWORK', 'RETRY_DELETION', 'SUSPENDED', 'UPDATE_NETWORK_REQUESTED', 'UPDATING_NETWORK']]

tgwStatus

  • Type: typing.Optional[typing.Literal['FAILED_UPDATE', 'NONE', 'SUCCESSFULLY_UPDATED', 'UPDATE_REQUESTED', 'UPDATING']]

dnsStatus

  • Type: typing.Optional[typing.Literal['FAILED_UPDATE', 'NONE', 'SUCCESSFULLY_UPDATED', 'UPDATE_REQUESTED', 'UPDATING']]

errorMessage

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

environmentArn

  • Type: typing.Optional[str]

kmsKeyId

  • Type: typing.Optional[str]

dedicatedServiceAccountId

  • Type: typing.Optional[str]

transitGatewayConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.finspace.finspace_classes.TransitGatewayConfigurationOutput]

customDNSConfiguration

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.finspace.finspace_classes.CustomDNSServer]]

creationTimestamp

  • Type: typing.Optional[datetime.datetime]

updateTimestamp

  • Type: typing.Optional[datetime.datetime]

availabilityZoneIds

  • Type: typing.Optional[typing.List[str]]

certificateAuthorityArn

  • Type: typing.Optional[str]

KxNAS1Configuration

type

  • Type: typing.Optional[typing.Literal['HDD_12', 'SSD_1000', 'SSD_250']]

size

  • Type: typing.Optional[int]

KxNode

nodeId

  • Type: typing.Optional[str]

availabilityZoneId

  • Type: typing.Optional[str]

launchTime

  • Type: typing.Optional[datetime.datetime]

status

  • Type: typing.Optional[typing.Literal['PROVISIONING', 'RUNNING']]

KxSavedownStorageConfiguration

type

  • Type: typing.Optional[typing.Literal['SDS01']]

size

  • Type: typing.Optional[int]

volumeName

  • Type: typing.Optional[str]

KxScalingGroup

scalingGroupName

  • Type: typing.Optional[str]

hostType

  • Type: typing.Optional[str]

clusters

  • Type: typing.Optional[typing.List[str]]

availabilityZoneId

  • Type: typing.Optional[str]

status

  • Type: typing.Optional[typing.Literal['ACTIVE', 'CREATE_FAILED', 'CREATING', 'DELETED', 'DELETE_FAILED', 'DELETING']]

statusReason

  • Type: typing.Optional[str]

lastModifiedTimestamp

  • Type: typing.Optional[datetime.datetime]

createdTimestamp

  • Type: typing.Optional[datetime.datetime]

KxScalingGroupConfiguration

scalingGroupName

  • Type:
  • Required: Yes

memoryReservation

  • Type:
  • Required: Yes

nodeCount

  • Type:
  • Required: Yes

memoryLimit

  • Type: typing.Optional[int]

cpu

  • Type: typing.Optional[float]

KxUser

userArn

  • Type: typing.Optional[str]

userName

  • Type: typing.Optional[str]

iamRole

  • Type: typing.Optional[str]

createTimestamp

  • Type: typing.Optional[datetime.datetime]

updateTimestamp

  • Type: typing.Optional[datetime.datetime]

KxVolume

volumeName

  • Type: typing.Optional[str]

volumeType

  • Type: typing.Optional[typing.Literal['NAS_1']]

status

  • Type: typing.Optional[typing.Literal['ACTIVE', 'CREATE_FAILED', 'CREATING', 'DELETED', 'DELETE_FAILED', 'DELETING', 'UPDATED', 'UPDATE_FAILED', 'UPDATING']]

description

  • Type: typing.Optional[str]

statusReason

  • Type: typing.Optional[str]

azMode

  • Type: typing.Optional[typing.Literal['MULTI', 'SINGLE']]

availabilityZoneIds

  • Type: typing.Optional[typing.List[str]]

createdTimestamp

  • Type: typing.Optional[datetime.datetime]

lastModifiedTimestamp

  • Type: typing.Optional[datetime.datetime]

ListEnvironmentsRequest

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListEnvironmentsResponse

environments

  • Type: typing.List[aws_resource_validator.pydantic_models.finspace.finspace_classes.Environment]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListKxChangesetsRequest

environmentId

  • Type:
  • Required: Yes

databaseName

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListKxChangesetsResponse

kxChangesets

  • Type: typing.List[aws_resource_validator.pydantic_models.finspace.finspace_classes.KxChangesetListEntry]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListKxClusterNodesRequest

environmentId

  • Type:
  • Required: Yes

clusterName

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListKxClusterNodesResponse

nodes

  • Type: typing.List[aws_resource_validator.pydantic_models.finspace.finspace_classes.KxNode]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListKxClustersRequest

environmentId

  • Type:
  • Required: Yes

clusterType

  • Type: typing.Optional[typing.Literal['GATEWAY', 'GP', 'HDB', 'RDB', 'TICKERPLANT']]

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

ListKxClustersResponse

kxClusterSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.finspace.finspace_classes.KxCluster]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListKxDatabasesRequest

environmentId

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListKxDatabasesResponse

kxDatabases

  • Type: typing.List[aws_resource_validator.pydantic_models.finspace.finspace_classes.KxDatabaseListEntry]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListKxDataviewsRequest

environmentId

  • Type:
  • Required: Yes

databaseName

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListKxDataviewsResponse

kxDataviews

  • Type: typing.List[aws_resource_validator.pydantic_models.finspace.finspace_classes.KxDataviewListEntry]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListKxEnvironmentsRequest

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListKxEnvironmentsRequestPaginate

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.finspace.finspace_classes.PaginatorConfig]

ListKxEnvironmentsResponse

environments

  • Type: typing.List[aws_resource_validator.pydantic_models.finspace.finspace_classes.KxEnvironment]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListKxScalingGroupsRequest

environmentId

  • Type:
  • Required: Yes

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

ListKxScalingGroupsResponse

scalingGroups

  • Type: typing.List[aws_resource_validator.pydantic_models.finspace.finspace_classes.KxScalingGroup]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListKxUsersRequest

environmentId

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListKxUsersResponse

users

  • Type: typing.List[aws_resource_validator.pydantic_models.finspace.finspace_classes.KxUser]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListKxVolumesRequest

environmentId

  • Type:
  • Required: Yes

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

volumeType

  • Type: typing.Optional[typing.Literal['NAS_1']]

ListKxVolumesResponse

kxVolumeSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.finspace.finspace_classes.KxVolume]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListTagsForResourceRequest

resourceArn

  • Type:
  • Required: Yes

ListTagsForResourceResponse

tags

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NetworkACLEntry

ruleNumber

  • Type:
  • Required: Yes

protocol

  • Type:
  • Required: Yes

ruleAction

  • Type: typing.Literal['allow', 'deny']
  • Required: Yes

cidrBlock

  • Type:
  • Required: Yes

portRange

  • Type: typing.Optional[aws_resource_validator.pydantic_models.finspace.finspace_classes.PortRange]

icmpTypeCode

  • Type: typing.Optional[aws_resource_validator.pydantic_models.finspace.finspace_classes.IcmpTypeCode]

PaginatorConfig

MaxItems

  • Type: typing.Optional[int]

PageSize

  • Type: typing.Optional[int]

StartingToken

  • Type: typing.Optional[str]

PortRange

from_

  • Type:
  • Required: Yes

to

  • Type:
  • Required: Yes

ResponseMetadata

RequestId

  • Type:
  • Required: Yes

HTTPStatusCode

  • Type:
  • Required: Yes

HTTPHeaders

  • Type: typing.Dict[str, str]
  • Required: Yes

RetryAttempts

  • Type:
  • Required: Yes

HostId

  • Type: typing.Optional[str]

SuperuserParameters

emailAddress

  • Type:
  • Required: Yes

firstName

  • Type:
  • Required: Yes

lastName

  • Type:
  • Required: Yes

TagResourceRequest

resourceArn

  • Type:
  • Required: Yes

tags

  • Type: typing.Dict[str, str]
  • Required: Yes

TickerplantLogConfiguration

tickerplantLogVolumes

  • Type: typing.Optional[typing.List[str]]

TickerplantLogConfigurationOutput

tickerplantLogVolumes

  • Type: typing.Optional[typing.List[str]]

TransitGatewayConfiguration

transitGatewayID

  • Type:
  • Required: Yes

routableCIDRSpace

  • Type:
  • Required: Yes

attachmentNetworkAclConfiguration

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.finspace.finspace_classes.NetworkACLEntry]]

TransitGatewayConfigurationOutput

transitGatewayID

  • Type:
  • Required: Yes

routableCIDRSpace

  • Type:
  • Required: Yes

attachmentNetworkAclConfiguration

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.finspace.finspace_classes.NetworkACLEntry]]

UntagResourceRequest

resourceArn

  • Type:
  • Required: Yes

tagKeys

  • Type: typing.List[str]
  • Required: Yes

UpdateEnvironmentRequest

environmentId

  • Type:
  • Required: Yes

name

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

federationMode

  • Type: typing.Optional[typing.Literal['FEDERATED', 'LOCAL']]

federationParameters

  • Type: typing.Union[aws_resource_validator.pydantic_models.finspace.finspace_classes.FederationParameters, aws_resource_validator.pydantic_models.finspace.finspace_classes.FederationParametersOutput, NoneType]

UpdateEnvironmentResponse

environment

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateKxClusterCodeConfigurationRequest

environmentId

  • Type:
  • Required: Yes

clusterName

  • Type:
  • Required: Yes

code

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

initializationScript

  • Type: typing.Optional[str]

commandLineArguments

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.finspace.finspace_classes.KxCommandLineArgument]]

deploymentConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.finspace.finspace_classes.KxClusterCodeDeploymentConfiguration]

UpdateKxClusterDatabasesRequest

environmentId

  • Type:
  • Required: Yes

clusterName

  • Type:
  • Required: Yes

databases

  • Type: typing.List[typing.Union[aws_resource_validator.pydantic_models.finspace.finspace_classes.KxDatabaseConfiguration, aws_resource_validator.pydantic_models.finspace.finspace_classes.KxDatabaseConfigurationOutput]]
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

deploymentConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.finspace.finspace_classes.KxDeploymentConfiguration]

UpdateKxDatabaseRequest

environmentId

  • Type:
  • Required: Yes

databaseName

  • Type:
  • Required: Yes

clientToken

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

UpdateKxDatabaseResponse

databaseName

  • Type:
  • Required: Yes

environmentId

  • Type:
  • Required: Yes

description

  • Type:
  • Required: Yes

lastModifiedTimestamp

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateKxDataviewRequest

environmentId

  • Type:
  • Required: Yes

databaseName

  • Type:
  • Required: Yes

dataviewName

  • Type:
  • Required: Yes

clientToken

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

changesetId

  • Type: typing.Optional[str]

segmentConfigurations

  • Type: typing.Optional[typing.List[typing.Union[aws_resource_validator.pydantic_models.finspace.finspace_classes.KxDataviewSegmentConfiguration, aws_resource_validator.pydantic_models.finspace.finspace_classes.KxDataviewSegmentConfigurationOutput]]]

UpdateKxDataviewResponse

environmentId

  • Type:
  • Required: Yes

databaseName

  • Type:
  • Required: Yes

dataviewName

  • Type:
  • Required: Yes

azMode

  • Type: typing.Literal['MULTI', 'SINGLE']
  • Required: Yes

availabilityZoneId

  • Type:
  • Required: Yes

changesetId

  • Type:
  • Required: Yes

segmentConfigurations

  • Type: typing.List[aws_resource_validator.pydantic_models.finspace.finspace_classes.KxDataviewSegmentConfigurationOutput]
  • Required: Yes

activeVersions

  • Type: typing.List[aws_resource_validator.pydantic_models.finspace.finspace_classes.KxDataviewActiveVersion]
  • Required: Yes

status

  • Type: typing.Literal['ACTIVE', 'CREATING', 'DELETING', 'FAILED', 'UPDATING']
  • Required: Yes

autoUpdate

  • Type:
  • Required: Yes

readWrite

  • Type:
  • Required: Yes

description

  • Type:
  • Required: Yes

createdTimestamp

  • Type:
  • Required: Yes

lastModifiedTimestamp

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateKxEnvironmentNetworkRequest

environmentId

  • Type:
  • Required: Yes

transitGatewayConfiguration

  • Type: typing.Union[aws_resource_validator.pydantic_models.finspace.finspace_classes.TransitGatewayConfiguration, aws_resource_validator.pydantic_models.finspace.finspace_classes.TransitGatewayConfigurationOutput, NoneType]

customDNSConfiguration

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.finspace.finspace_classes.CustomDNSServer]]

clientToken

  • Type: typing.Optional[str]

UpdateKxEnvironmentNetworkResponse

name

  • Type:
  • Required: Yes

environmentId

  • Type:
  • Required: Yes

awsAccountId

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['CREATED', 'CREATE_REQUESTED', 'CREATING', 'DELETED', 'DELETE_REQUESTED', 'DELETING', 'FAILED_CREATION', 'FAILED_DELETION', 'FAILED_UPDATING_NETWORK', 'RETRY_DELETION', 'SUSPENDED', 'UPDATE_NETWORK_REQUESTED', 'UPDATING_NETWORK']
  • Required: Yes

tgwStatus

  • Type: typing.Literal['FAILED_UPDATE', 'NONE', 'SUCCESSFULLY_UPDATED', 'UPDATE_REQUESTED', 'UPDATING']
  • Required: Yes

dnsStatus

  • Type: typing.Literal['FAILED_UPDATE', 'NONE', 'SUCCESSFULLY_UPDATED', 'UPDATE_REQUESTED', 'UPDATING']
  • Required: Yes

errorMessage

  • Type:
  • Required: Yes

description

  • Type:
  • Required: Yes

environmentArn

  • Type:
  • Required: Yes

kmsKeyId

  • Type:
  • Required: Yes

dedicatedServiceAccountId

  • Type:
  • Required: Yes

transitGatewayConfiguration

  • Type:
  • Required: Yes

customDNSConfiguration

  • Type: typing.List[aws_resource_validator.pydantic_models.finspace.finspace_classes.CustomDNSServer]
  • Required: Yes

creationTimestamp

  • Type:
  • Required: Yes

updateTimestamp

  • Type:
  • Required: Yes

availabilityZoneIds

  • Type: typing.List[str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateKxEnvironmentRequest

environmentId

  • Type:
  • Required: Yes

name

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

clientToken

  • Type: typing.Optional[str]

UpdateKxEnvironmentResponse

name

  • Type:
  • Required: Yes

environmentId

  • Type:
  • Required: Yes

awsAccountId

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['CREATED', 'CREATE_REQUESTED', 'CREATING', 'DELETED', 'DELETE_REQUESTED', 'DELETING', 'FAILED_CREATION', 'FAILED_DELETION', 'FAILED_UPDATING_NETWORK', 'RETRY_DELETION', 'SUSPENDED', 'UPDATE_NETWORK_REQUESTED', 'UPDATING_NETWORK']
  • Required: Yes

tgwStatus

  • Type: typing.Literal['FAILED_UPDATE', 'NONE', 'SUCCESSFULLY_UPDATED', 'UPDATE_REQUESTED', 'UPDATING']
  • Required: Yes

dnsStatus

  • Type: typing.Literal['FAILED_UPDATE', 'NONE', 'SUCCESSFULLY_UPDATED', 'UPDATE_REQUESTED', 'UPDATING']
  • Required: Yes

errorMessage

  • Type:
  • Required: Yes

description

  • Type:
  • Required: Yes

environmentArn

  • Type:
  • Required: Yes

kmsKeyId

  • Type:
  • Required: Yes

dedicatedServiceAccountId

  • Type:
  • Required: Yes

transitGatewayConfiguration

  • Type:
  • Required: Yes

customDNSConfiguration

  • Type: typing.List[aws_resource_validator.pydantic_models.finspace.finspace_classes.CustomDNSServer]
  • Required: Yes

creationTimestamp

  • Type:
  • Required: Yes

updateTimestamp

  • Type:
  • Required: Yes

availabilityZoneIds

  • Type: typing.List[str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateKxUserRequest

environmentId

  • Type:
  • Required: Yes

userName

  • Type:
  • Required: Yes

iamRole

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

UpdateKxUserResponse

userName

  • Type:
  • Required: Yes

userArn

  • Type:
  • Required: Yes

environmentId

  • Type:
  • Required: Yes

iamRole

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateKxVolumeRequest

environmentId

  • Type:
  • Required: Yes

volumeName

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

clientToken

  • Type: typing.Optional[str]

nas1Configuration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.finspace.finspace_classes.KxNAS1Configuration]

UpdateKxVolumeResponse

environmentId

  • Type:
  • Required: Yes

volumeName

  • Type:
  • Required: Yes

volumeType

  • Type: typing.Literal['NAS_1']
  • Required: Yes

volumeArn

  • Type:
  • Required: Yes

nas1Configuration

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['ACTIVE', 'CREATE_FAILED', 'CREATING', 'DELETED', 'DELETE_FAILED', 'DELETING', 'UPDATED', 'UPDATE_FAILED', 'UPDATING']
  • Required: Yes

description

  • Type:
  • Required: Yes

statusReason

  • Type:
  • Required: Yes

createdTimestamp

  • Type:
  • Required: Yes

azMode

  • Type: typing.Literal['MULTI', 'SINGLE']
  • Required: Yes

availabilityZoneIds

  • Type: typing.List[str]
  • Required: Yes

lastModifiedTimestamp

  • Type:
  • Required: Yes

attachedClusters

  • Type: typing.List[aws_resource_validator.pydantic_models.finspace.finspace_classes.KxAttachedCluster]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

Volume

volumeName

  • Type: typing.Optional[str]

volumeType

  • Type: typing.Optional[typing.Literal['NAS_1']]

VpcConfiguration

vpcId

  • Type: typing.Optional[str]

securityGroupIds

  • Type: typing.Optional[typing.List[str]]

subnetIds

  • Type: typing.Optional[typing.List[str]]

ipAddressType

  • Type: typing.Optional[typing.Literal['IP_V4']]

VpcConfigurationOutput

vpcId

  • Type: typing.Optional[str]

securityGroupIds

  • Type: typing.Optional[typing.List[str]]

subnetIds

  • Type: typing.Optional[typing.List[str]]

ipAddressType

  • Type: typing.Optional[typing.Literal['IP_V4']]