Skip to content
v2.275.0

CfnInfluxDBClusterProps Struct ​

Properties for defining a CfnInfluxDBCluster.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_timestream as timestream } from 'aws-cdk-lib';
const cfnInfluxDBClusterProps: timestream.CfnInfluxDBClusterProps = {
  allocatedStorage: 123,
  bucket: 'bucket',
  dbInstanceType: 'dbInstanceType',
  dbParameterGroupIdentifier: 'dbParameterGroupIdentifier',
  dbStorageType: 'dbStorageType',
  deploymentType: 'deploymentType',
  failoverMode: 'failoverMode',
  logDeliveryConfiguration: {
    s3Configuration: {
      bucketName: 'bucketName',
      enabled: false,
    },
  },
  maintenanceSchedule: {
    preferredMaintenanceWindow: 'preferredMaintenanceWindow',
    timezone: 'timezone',
  },
  name: 'name',
  networkType: 'networkType',
  organization: 'organization',
  password: 'password',
  port: 123,
  publiclyAccessible: false,
  tags: [{
    key: 'key',
    value: 'value',
  }],
  username: 'username',
  vpcSecurityGroupIds: ['vpcSecurityGroupIds'],
  vpcSubnetIds: ['vpcSubnetIds'],
};

Properties ​

allocatedStorageoptionalnumberallocated_storageoptionalint | floatallocatedStorageoptionalNumberAllocatedStorageoptionaldoubleAllocatedStorageoptional*float64#
The allocated storage for the InfluxDB cluster.
bucketoptionalstringbucketoptionalstrbucketoptionalStringBucketoptionalstringBucketoptional*string#
The bucket for the InfluxDB cluster.
dbInstanceTypeoptionalstringdb_instance_typeoptionalstrdbInstanceTypeoptionalStringDbInstanceTypeoptionalstringDbInstanceTypeoptional*string#
The compute instance of the InfluxDB cluster.
dbParameterGroupIdentifieroptionalstringdb_parameter_group_identifieroptionalstrdbParameterGroupIdentifieroptionalStringDbParameterGroupIdentifieroptionalstringDbParameterGroupIdentifieroptional*string#
The name of an existing InfluxDB parameter group.
dbStorageTypeoptionalstringdb_storage_typeoptionalstrdbStorageTypeoptionalStringDbStorageTypeoptionalstringDbStorageTypeoptional*string#
The storage type of the InfluxDB cluster.
deploymentTypeoptionalstringdeployment_typeoptionalstrdeploymentTypeoptionalStringDeploymentTypeoptionalstringDeploymentTypeoptional*string#
Deployment type of the InfluxDB cluster.
failoverModeoptionalstringfailover_modeoptionalstrfailoverModeoptionalStringFailoverModeoptionalstringFailoverModeoptional*string#
Failover mode of the InfluxDB cluster.
logDeliveryConfigurationoptionalIResolvable | CfnInfluxDBCluster.LogDeliveryConfigurationPropertylog_delivery_configurationoptionaltyping.Union[IResolvable, LogDeliveryConfigurationProperty]logDeliveryConfigurationoptionalIResolvableLogDeliveryConfigurationoptionalIResolvableLogDeliveryConfigurationoptionalinterface{}#
Configuration for sending logs to customer account from the InfluxDB cluster.
maintenanceScheduleoptionalIResolvable | CfnInfluxDBCluster.MaintenanceSchedulePropertymaintenance_scheduleoptionaltyping.Union[IResolvable, MaintenanceScheduleProperty]maintenanceScheduleoptionalIResolvableMaintenanceScheduleoptionalIResolvableMaintenanceScheduleoptionalinterface{}#
The maintenance schedule for the InfluxDB cluster.
nameoptionalstringnameoptionalstrnameoptionalStringNameoptionalstringNameoptional*string#
The unique name that is associated with the InfluxDB cluster.
networkTypeoptionalstringnetwork_typeoptionalstrnetworkTypeoptionalStringNetworkTypeoptionalstringNetworkTypeoptional*string#
Network type of the InfluxDB cluster.
organizationoptionalstringorganizationoptionalstrorganizationoptionalStringOrganizationoptionalstringOrganizationoptional*string#
The organization for the InfluxDB cluster.
passwordoptionalstringpasswordoptionalstrpasswordoptionalStringPasswordoptionalstringPasswordoptional*string#
The password for the InfluxDB cluster.
portoptionalnumberportoptionalint | floatportoptionalNumberPortoptionaldoublePortoptional*float64#
The port number on which InfluxDB accepts connections.
publiclyAccessibleoptionalboolean | IResolvablepublicly_accessibleoptionaltyping.Union[bool, IResolvable]publiclyAccessibleoptionalBooleanPubliclyAccessibleoptionalboolPubliclyAccessibleoptionalinterface{}= false#
Attach a public IP to the customer ENI.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
An arbitrary set of tags (key-value pairs) for this DB cluster.
usernameoptionalstringusernameoptionalstrusernameoptionalStringUsernameoptionalstringUsernameoptional*string#
The username for the InfluxDB cluster.
vpcSecurityGroupIdsoptionalstring[]vpc_security_group_idsoptionaltyping.List[str]vpcSecurityGroupIdsoptionalList<String>VpcSecurityGroupIdsoptionalstring[]VpcSecurityGroupIdsoptional*[]*string#
A list of Amazon EC2 VPC security groups to associate with this InfluxDB cluster.
vpcSubnetIdsoptionalstring[]vpc_subnet_idsoptionaltyping.List[str]vpcSubnetIdsoptionalList<String>VpcSubnetIdsoptionalstring[]VpcSubnetIdsoptional*[]*string#
A list of EC2 subnet IDs for this InfluxDB cluster.