Skip to content

Update Kx Environment Network

finspace_update_kx_environment_network R Documentation

Updates environment network to connect to your internal network by using a transit gateway

Description

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.

Usage

finspace_update_kx_environment_network(environmentId,
  transitGatewayConfiguration, customDNSConfiguration, clientToken)

Arguments

environmentId

[required] A unique identifier for the kdb environment.

transitGatewayConfiguration

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

customDNSConfiguration

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

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_network(
  environmentId = "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"
    )
  ),
  clientToken = "string"
)