class CfnInfluxDBInstance (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Timestream.CfnInfluxDBInstance |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awstimestream#CfnInfluxDBInstance |
![]() | software.amazon.awscdk.services.timestream.CfnInfluxDBInstance |
![]() | aws_cdk.aws_timestream.CfnInfluxDBInstance |
![]() | aws-cdk-lib » aws_timestream » CfnInfluxDBInstance |
Implements
IConstruct
, IDependable
, IInspectable
, ITaggable
A DB instance is an isolated database environment running in the cloud.
It is the basic building block of Amazon Timestream for InfluxDB. A DB instance can contain multiple user-created databases (or organizations and buckets for the case of InfluxDb 2.x databases), and can be accessed using the same client tools and applications you might use to access a standalone self-managed InfluxDB instance.
Example
// 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 cfnInfluxDBInstance = new timestream.CfnInfluxDBInstance(this, 'MyCfnInfluxDBInstance', /* all optional props */ {
allocatedStorage: 123,
bucket: 'bucket',
dbInstanceType: 'dbInstanceType',
dbParameterGroupIdentifier: 'dbParameterGroupIdentifier',
dbStorageType: 'dbStorageType',
deploymentType: 'deploymentType',
logDeliveryConfiguration: {
s3Configuration: {
bucketName: 'bucketName',
enabled: false,
},
},
name: 'name',
networkType: 'networkType',
organization: 'organization',
password: 'password',
port: 123,
publiclyAccessible: false,
tags: [{
key: 'key',
value: 'value',
}],
username: 'username',
vpcSecurityGroupIds: ['vpcSecurityGroupIds'],
vpcSubnetIds: ['vpcSubnetIds'],
});
Initializer
new CfnInfluxDBInstance(scope: Construct, id: string, props?: CfnInfluxDBInstanceProps)
Parameters
- scope
Construct
— Scope in which this resource is defined. - id
string
— Construct identifier for this resource (unique in its scope). - props
Cfn
— Resource properties.Influx DBInstance Props
Construct Props
Name | Type | Description |
---|---|---|
allocated | number | The amount of storage to allocate for your DB storage type in GiB (gibibytes). |
bucket? | string | The name of the initial InfluxDB bucket. |
db | string | The Timestream for InfluxDB DB instance type to run on. |
db | string | The name or id of the DB parameter group to assign to your DB instance. |
db | string | The Timestream for InfluxDB DB storage type to read and write InfluxDB data. |
deployment | string | Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability. |
log | IResolvable | Log | Configuration for sending InfluxDB engine logs to a specified S3 bucket. |
name? | string | The name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands. |
network | string | Network type of the InfluxDB Instance. |
organization? | string | The name of the initial organization for the initial admin user in InfluxDB. |
password? | string | The password of the initial admin user created in InfluxDB. |
port? | number | The port number on which InfluxDB accepts connections. |
publicly | boolean | IResolvable | Configures the DB instance with a public IP to facilitate access. |
tags? | Cfn [] | A list of key-value pairs to associate with the DB instance. |
username? | string | The username of the initial admin user created in InfluxDB. |
vpc | string[] | A list of VPC security group IDs to associate with the DB instance. |
vpc | string[] | A list of VPC subnet IDs to associate with the DB instance. |
allocatedStorage?
Type:
number
(optional)
The amount of storage to allocate for your DB storage type in GiB (gibibytes).
bucket?
Type:
string
(optional)
The name of the initial InfluxDB bucket.
All InfluxDB data is stored in a bucket. A bucket combines the concept of a database and a retention period (the duration of time that each data point persists). A bucket belongs to an organization.
dbInstanceType?
Type:
string
(optional)
The Timestream for InfluxDB DB instance type to run on.
dbParameterGroupIdentifier?
Type:
string
(optional)
The name or id of the DB parameter group to assign to your DB instance.
DB parameter groups specify how the database is configured. For example, DB parameter groups can specify the limit for query concurrency.
dbStorageType?
Type:
string
(optional)
The Timestream for InfluxDB DB storage type to read and write InfluxDB data.
You can choose between 3 different types of provisioned Influx IOPS included storage according to your workloads requirements:
- Influx IO Included 3000 IOPS
- Influx IO Included 12000 IOPS
- Influx IO Included 16000 IOPS
deploymentType?
Type:
string
(optional)
Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.
logDeliveryConfiguration?
Type:
IResolvable
|
Log
(optional)
Configuration for sending InfluxDB engine logs to a specified S3 bucket.
name?
Type:
string
(optional)
The name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands.
This name will also be a prefix included in the endpoint. DB instance names must be unique per customer and per region.
networkType?
Type:
string
(optional)
Network type of the InfluxDB Instance.
organization?
Type:
string
(optional)
The name of the initial organization for the initial admin user in InfluxDB.
An InfluxDB organization is a workspace for a group of users.
password?
Type:
string
(optional)
The password of the initial admin user created in InfluxDB.
This password will allow you to access the InfluxDB UI to perform various administrative tasks and also use the InfluxDB CLI to create an operator token. These attributes will be stored in a Secret created in Amazon SecretManager in your account.
port?
Type:
number
(optional)
The port number on which InfluxDB accepts connections.
publiclyAccessible?
Type:
boolean |
IResolvable
(optional, default: false)
Configures the DB instance with a public IP to facilitate access.
tags?
Type:
Cfn
[]
(optional)
A list of key-value pairs to associate with the DB instance.
username?
Type:
string
(optional)
The username of the initial admin user created in InfluxDB.
Must start with a letter and can't end with a hyphen or contain two consecutive hyphens. For example, my-user1. This username will allow you to access the InfluxDB UI to perform various administrative tasks and also use the InfluxDB CLI to create an operator token. These attributes will be stored in a Secret created in Amazon Secrets Manager in your account.
vpcSecurityGroupIds?
Type:
string[]
(optional)
A list of VPC security group IDs to associate with the DB instance.
vpcSubnetIds?
Type:
string[]
(optional)
A list of VPC subnet IDs to associate with the DB instance.
Provide at least two VPC subnet IDs in different availability zones when deploying with a Multi-AZ standby.
Properties
Name | Type | Description |
---|---|---|
attr | string | The Amazon Resource Name (ARN) of the DB instance. |
attr | string | The Availability Zone in which the DB instance resides. |
attr | string | The endpoint used to connect to InfluxDB. |
attr | string | A service-generated unique identifier. |
attr | string | The Amazon Resource Name (ARN) of the Amazon Secrets Manager secret containing the initial InfluxDB authorization parameters. |
attr | string | Describes an Availability Zone in which the InfluxDB instance is located. |
attr | string | The status of the DB instance. |
cdk | Tag | Tag Manager which manages the tags for this resource. |
cfn | ICfn | Options for this resource, such as condition, update policy etc. |
cfn | { [string]: any } | |
cfn | string | AWS resource type. |
creation | string[] | |
logical | string | The logical ID for this CloudFormation stack element. |
node | Node | The tree node. |
ref | string | Return a string that will be resolved to a CloudFormation { Ref } for this element. |
stack | Stack | The stack in which this element is defined. |
allocated | number | The amount of storage to allocate for your DB storage type in GiB (gibibytes). |
bucket? | string | The name of the initial InfluxDB bucket. |
db | string | The Timestream for InfluxDB DB instance type to run on. |
db | string | The name or id of the DB parameter group to assign to your DB instance. |
db | string | The Timestream for InfluxDB DB storage type to read and write InfluxDB data. |
deployment | string | Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability. |
log | IResolvable | Log | Configuration for sending InfluxDB engine logs to a specified S3 bucket. |
name? | string | The name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands. |
network | string | Network type of the InfluxDB Instance. |
organization? | string | The name of the initial organization for the initial admin user in InfluxDB. |
password? | string | The password of the initial admin user created in InfluxDB. |
port? | number | The port number on which InfluxDB accepts connections. |
publicly | boolean | IResolvable | Configures the DB instance with a public IP to facilitate access. |
tags? | Cfn [] | A list of key-value pairs to associate with the DB instance. |
username? | string | The username of the initial admin user created in InfluxDB. |
vpc | string[] | A list of VPC security group IDs to associate with the DB instance. |
vpc | string[] | A list of VPC subnet IDs to associate with the DB instance. |
static CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. |
attrArn
Type:
string
The Amazon Resource Name (ARN) of the DB instance.
attrAvailabilityZone
Type:
string
The Availability Zone in which the DB instance resides.
attrEndpoint
Type:
string
The endpoint used to connect to InfluxDB.
The default InfluxDB port is 8086.
attrId
Type:
string
A service-generated unique identifier.
attrInfluxAuthParametersSecretArn
Type:
string
The Amazon Resource Name (ARN) of the Amazon Secrets Manager secret containing the initial InfluxDB authorization parameters.
The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.
attrSecondaryAvailabilityZone
Type:
string
Describes an Availability Zone in which the InfluxDB instance is located.
attrStatus
Type:
string
The status of the DB instance.
Valid Values: CREATING
| AVAILABLE
| DELETING
| MODIFYING
| UPDATING
| DELETED
| FAILED
cdkTagManager
Type:
Tag
Tag Manager which manages the tags for this resource.
cfnOptions
Type:
ICfn
Options for this resource, such as condition, update policy etc.
cfnProperties
Type:
{ [string]: any }
cfnResourceType
Type:
string
AWS resource type.
creationStack
Type:
string[]
logicalId
Type:
string
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use overrideLogicalId(newLogicalId)
.
node
Type:
Node
The tree node.
ref
Type:
string
Return a string that will be resolved to a CloudFormation { Ref }
for this element.
If, by any chance, the intrinsic reference of a resource is not a string, you could
coerce it to an IResolvable through Lazy.any({ produce: resource.ref })
.
stack
Type:
Stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
allocatedStorage?
Type:
number
(optional)
The amount of storage to allocate for your DB storage type in GiB (gibibytes).
bucket?
Type:
string
(optional)
The name of the initial InfluxDB bucket.
dbInstanceType?
Type:
string
(optional)
The Timestream for InfluxDB DB instance type to run on.
dbParameterGroupIdentifier?
Type:
string
(optional)
The name or id of the DB parameter group to assign to your DB instance.
dbStorageType?
Type:
string
(optional)
The Timestream for InfluxDB DB storage type to read and write InfluxDB data.
deploymentType?
Type:
string
(optional)
Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.
logDeliveryConfiguration?
Type:
IResolvable
|
Log
(optional)
Configuration for sending InfluxDB engine logs to a specified S3 bucket.
name?
Type:
string
(optional)
The name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands.
networkType?
Type:
string
(optional)
Network type of the InfluxDB Instance.
organization?
Type:
string
(optional)
The name of the initial organization for the initial admin user in InfluxDB.
password?
Type:
string
(optional)
The password of the initial admin user created in InfluxDB.
port?
Type:
number
(optional)
The port number on which InfluxDB accepts connections.
publiclyAccessible?
Type:
boolean |
IResolvable
(optional)
Configures the DB instance with a public IP to facilitate access.
tags?
Type:
Cfn
[]
(optional)
A list of key-value pairs to associate with the DB instance.
username?
Type:
string
(optional)
The username of the initial admin user created in InfluxDB.
vpcSecurityGroupIds?
Type:
string[]
(optional)
A list of VPC security group IDs to associate with the DB instance.
vpcSubnetIds?
Type:
string[]
(optional)
A list of VPC subnet IDs to associate with the DB instance.
static CFN_RESOURCE_TYPE_NAME
Type:
string
The CloudFormation resource type name for this resource class.
Methods
Name | Description |
---|---|
add | Syntactic sugar for addOverride(path, undefined) . |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Add a value to the CloudFormation Resource Metadata. |
add | Adds an override to the synthesized CloudFormation resource. |
add | Adds an override that deletes the value of a property from the resource definition. |
add | Adds an override to a resource property. |
apply | Sets the deletion policy of the resource based on the removal policy specified. |
get | Returns a token for an runtime attribute of this resource. |
get | Retrieve a value value from the CloudFormation Resource Metadata. |
inspect(inspector) | Examines the CloudFormation resource and discloses attributes. |
obtain | Retrieves an array of resources this resource depends on. |
obtain | Get a shallow copy of dependencies between this resource and other resources in the same stack. |
override | Overrides the auto-generated logical ID with a specific ID. |
remove | Indicates that this resource no longer depends on another resource. |
replace | Replaces one dependency with another. |
to | Returns a string representation of this construct. |
protected render |
addDeletionOverride(path)
public addDeletionOverride(path: string): void
Parameters
- path
string
— The path of the value to delete.
Syntactic sugar for addOverride(path, undefined)
.
addDependency(target)
public addDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
addDependsOn(target)
public addDependsOn(target: CfnResource): void
⚠️ Deprecated: use addDependency
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)
public addMetadata(key: string, value: any): void
Parameters
- key
string
- value
any
Add a value to the CloudFormation Resource Metadata.
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
addOverride(path, value)
public addOverride(path: string, value: any): void
Parameters
- path
string
— - The path of the property, you can use dot notation to override values in complex types. - value
any
— - The value.
Adds an override to the synthesized CloudFormation resource.
To add a
property override, either use addPropertyOverride
or prefix path
with
"Properties." (i.e. Properties.TopicName
).
If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal .
in the property name, prefix with a \
. In most
programming languages you will need to write this as "\\."
because the
\
itself will need to be escaped.
For example,
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
The value
argument to addOverride
will not be processed or translated
in any way. Pass raw JSON values in here with the correct capitalization
for CloudFormation. If you pass CDK classes or structs, they will be
rendered with lowercased key names, and CloudFormation will reject the
template.
addPropertyDeletionOverride(propertyPath)
public addPropertyDeletionOverride(propertyPath: string): void
Parameters
- propertyPath
string
— The path to the property.
Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)
public addPropertyOverride(propertyPath: string, value: any): void
Parameters
- propertyPath
string
— The path of the property. - value
any
— The value.
Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value)
.
applyRemovalPolicy(policy?, options?)
public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void
Parameters
- policy
Removal
Policy - options
Removal
Policy Options
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY
), or left in your AWS
account for data recovery and cleanup later (RemovalPolicy.RETAIN
). In some
cases, a snapshot can be taken of the resource prior to deletion
(RemovalPolicy.SNAPSHOT
). A list of resources that support this policy
can be found in the following link:
getAtt(attributeName, typeHint?)
public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference
Parameters
- attributeName
string
— The name of the attribute. - typeHint
Resolution
Type Hint
Returns
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn
), but this can be used for future compatibility
in case there is no generated attribute.
getMetadata(key)
public getMetadata(key: string): any
Parameters
- key
string
Returns
any
Retrieve a value value from the CloudFormation Resource Metadata.
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
inspect(inspector)
public inspect(inspector: TreeInspector): void
Parameters
- inspector
Tree
— tree inspector to collect and process attributes.Inspector
Examines the CloudFormation resource and discloses attributes.
obtainDependencies()
public obtainDependencies(): Stack | CfnResource[]
Returns
Stack
|
Cfn
Resource []
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
obtainResourceDependencies()
public obtainResourceDependencies(): CfnResource[]
Returns
Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)
public overrideLogicalId(newLogicalId: string): void
Parameters
- newLogicalId
string
— The new logical ID to use for this stack element.
Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)
public removeDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
replaceDependency(target, newTarget)
public replaceDependency(target: CfnResource, newTarget: CfnResource): void
Parameters
- target
Cfn
— The dependency to replace.Resource - newTarget
Cfn
— The new dependency to add.Resource
Replaces one dependency with another.
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.
protected renderProperties(props)
protected renderProperties(props: { [string]: any }): { [string]: any }
Parameters
- props
{ [string]: any }
Returns
{ [string]: any }