Skip to content

Update Kx Environment

finspace_update_kx_environment R Documentation

Updates information for the given kdb environment

Description

Updates information for the given kdb environment.

Usage

finspace_update_kx_environment(environmentId, name, description,
  clientToken)

Arguments

environmentId

[required] A unique identifier for the kdb environment.

name

The name of the kdb environment.

description

A description of the kdb environment.

clientToken

A token that ensures idempotency. This token expires in 10 minutes.

Value

A list with the following syntax: 

list(
  name = "string",
  environmentId = "string",
  awsAccountId = "string",
  status = "CREATE_REQUESTED"|"CREATING"|"CREATED"|"DELETE_REQUESTED"|"DELETING"|"DELETED"|"FAILED_CREATION"|"RETRY_DELETION"|"FAILED_DELETION"|"UPDATE_NETWORK_REQUESTED"|"UPDATING_NETWORK"|"FAILED_UPDATING_NETWORK"|"SUSPENDED",
  tgwStatus = "NONE"|"UPDATE_REQUESTED"|"UPDATING"|"FAILED_UPDATE"|"SUCCESSFULLY_UPDATED",
  dnsStatus = "NONE"|"UPDATE_REQUESTED"|"UPDATING"|"FAILED_UPDATE"|"SUCCESSFULLY_UPDATED",
  errorMessage = "string",
  description = "string",
  environmentArn = "string",
  kmsKeyId = "string",
  dedicatedServiceAccountId = "string",
  transitGatewayConfiguration = list(
    transitGatewayID = "string",
    routableCIDRSpace = "string",
    attachmentNetworkAclConfiguration = list(
      list(
        ruleNumber = 123,
        protocol = "string",
        ruleAction = "allow"|"deny",
        portRange = list(
          from = 123,
          to = 123
        ),
        icmpTypeCode = list(
          type = 123,
          code = 123
        ),
        cidrBlock = "string"
      )
    )
  ),
  customDNSConfiguration = list(
    list(
      customDNSServerName = "string",
      customDNSServerIP = "string"
    )
  ),
  creationTimestamp = as.POSIXct(
    "2015-01-01"
  ),
  updateTimestamp = as.POSIXct(
    "2015-01-01"
  ),
  availabilityZoneIds = list(
    "string"
  )
)

Request syntax

svc$update_kx_environment(
  environmentId = "string",
  name = "string",
  description = "string",
  clientToken = "string"
)