CfnInfluxDBInstancePropsMixin

class aws_cdk.mixins_preview.aws_timestream.mixins.CfnInfluxDBInstancePropsMixin(props, *, strategy=None)

Bases: Mixin

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html
CloudformationResource:: AWS::Timestream::InfluxDBInstance
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_timestream import mixins as timestream_mixins

cfn_influx_dBInstance_props_mixin = timestream_mixins.CfnInfluxDBInstancePropsMixin(timestream_mixins.CfnInfluxDBInstanceMixinProps(
    allocated_storage=123,
    bucket="bucket",
    db_instance_type="dbInstanceType",
    db_parameter_group_identifier="dbParameterGroupIdentifier",
    db_storage_type="dbStorageType",
    deployment_type="deploymentType",
    log_delivery_configuration=timestream_mixins.CfnInfluxDBInstancePropsMixin.LogDeliveryConfigurationProperty(
        s3_configuration=timestream_mixins.CfnInfluxDBInstancePropsMixin.S3ConfigurationProperty(
            bucket_name="bucketName",
            enabled=False
        )
    ),
    name="name",
    network_type="networkType",
    organization="organization",
    password="password",
    port=123,
    publicly_accessible=False,
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    username="username",
    vpc_security_group_ids=["vpcSecurityGroupIds"],
    vpc_subnet_ids=["vpcSubnetIds"]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Timestream::InfluxDBInstance.

Parameters:

props (Union[CfnInfluxDBInstanceMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['allocatedStorage', 'bucket', 'dbInstanceType', 'dbParameterGroupIdentifier', 'dbStorageType', 'deploymentType', 'logDeliveryConfiguration', 'name', 'networkType', 'organization', 'password', 'port', 'publiclyAccessible', 'tags', 'username', 'vpcSecurityGroupIds', 'vpcSubnetIds']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

LogDeliveryConfigurationProperty

class CfnInfluxDBInstancePropsMixin.LogDeliveryConfigurationProperty(*, s3_configuration=None)

Bases: object

Configuration for sending InfluxDB engine logs to a specified S3 bucket.

Parameters:: s3_configuration (Union[IResolvable, S3ConfigurationProperty, Dict[str, Any], None]) – Configuration for S3 bucket log delivery.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-influxdbinstance-logdeliveryconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_timestream import mixins as timestream_mixins

log_delivery_configuration_property = timestream_mixins.CfnInfluxDBInstancePropsMixin.LogDeliveryConfigurationProperty(
    s3_configuration=timestream_mixins.CfnInfluxDBInstancePropsMixin.S3ConfigurationProperty(
        bucket_name="bucketName",
        enabled=False
    )
)

Attributes

s3_configuration

Configuration for S3 bucket log delivery.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-influxdbinstance-logdeliveryconfiguration.html#cfn-timestream-influxdbinstance-logdeliveryconfiguration-s3configuration

S3ConfigurationProperty

class CfnInfluxDBInstancePropsMixin.S3ConfigurationProperty(*, bucket_name=None, enabled=None)

Bases: object

Configuration for S3 bucket log delivery.

Parameters:

bucket_name (Optional[str]) – The bucket name of the customer S3 bucket.
enabled (Union[bool, IResolvable, None]) – Indicates whether log delivery to the S3 bucket is enabled.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-influxdbinstance-s3configuration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_timestream import mixins as timestream_mixins

s3_configuration_property = timestream_mixins.CfnInfluxDBInstancePropsMixin.S3ConfigurationProperty(
    bucket_name="bucketName",
    enabled=False
)

Attributes

bucket_name

The bucket name of the customer S3 bucket.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-influxdbinstance-s3configuration.html#cfn-timestream-influxdbinstance-s3configuration-bucketname

enabled

Indicates whether log delivery to the S3 bucket is enabled.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-influxdbinstance-s3configuration.html#cfn-timestream-influxdbinstance-s3configuration-enabled