@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
221 lines (220 loc) • 8.15 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* The AWS::Timestream::InfluxDBCluster resource creates an InfluxDB cluster.
*/
export declare class InfluxDbCluster extends pulumi.CustomResource {
/**
* Get an existing InfluxDbCluster resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): InfluxDbCluster;
/**
* Returns true if the given object is an instance of InfluxDbCluster. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is InfluxDbCluster;
/**
* The allocated storage for the InfluxDB cluster.
*/
readonly allocatedStorage: pulumi.Output<number | undefined>;
/**
* The Amazon Resource Name (ARN) that is associated with the InfluxDB cluster.
*/
readonly arn: pulumi.Output<string>;
/**
* The service generated unique identifier for InfluxDB cluster.
*/
readonly awsId: pulumi.Output<string>;
/**
* The bucket for the InfluxDB cluster.
*/
readonly bucket: pulumi.Output<string | undefined>;
/**
* The compute instance of the InfluxDB cluster.
*/
readonly dbInstanceType: pulumi.Output<enums.timestream.InfluxDbClusterDbInstanceType | undefined>;
/**
* The name of an existing InfluxDB parameter group.
*/
readonly dbParameterGroupIdentifier: pulumi.Output<string | undefined>;
/**
* The storage type of the InfluxDB cluster.
*/
readonly dbStorageType: pulumi.Output<enums.timestream.InfluxDbClusterDbStorageType | undefined>;
/**
* Deployment type of the InfluxDB cluster.
*/
readonly deploymentType: pulumi.Output<enums.timestream.InfluxDbClusterDeploymentType | undefined>;
/**
* The connection endpoint for the InfluxDB cluster.
*/
readonly endpoint: pulumi.Output<string>;
/**
* The engine type for the InfluxDB cluster.
*/
readonly engineType: pulumi.Output<enums.timestream.InfluxDbClusterEngineType>;
/**
* Failover mode of the InfluxDB cluster.
*/
readonly failoverMode: pulumi.Output<enums.timestream.InfluxDbClusterFailoverMode | undefined>;
/**
* The Auth parameters secret Amazon Resource name (ARN) that is associated with the InfluxDB cluster.
*/
readonly influxAuthParametersSecretArn: pulumi.Output<string>;
/**
* Configuration for sending logs to customer account from the InfluxDB cluster.
*/
readonly logDeliveryConfiguration: pulumi.Output<outputs.timestream.LogDeliveryConfigurationProperties | undefined>;
/**
* The maintenance schedule for the InfluxDB cluster.
*/
readonly maintenanceSchedule: pulumi.Output<outputs.timestream.InfluxDbClusterMaintenanceSchedule | undefined>;
/**
* The unique name that is associated with the InfluxDB cluster.
*/
readonly name: pulumi.Output<string | undefined>;
/**
* Network type of the InfluxDB cluster.
*/
readonly networkType: pulumi.Output<enums.timestream.InfluxDbClusterNetworkType | undefined>;
/**
* The timestamp of the next scheduled maintenance event.
*/
readonly nextMaintenanceTime: pulumi.Output<string>;
/**
* The organization for the InfluxDB cluster.
*/
readonly organization: pulumi.Output<string | undefined>;
/**
* The password for the InfluxDB cluster.
*/
readonly password: pulumi.Output<string | undefined>;
/**
* The port number on which InfluxDB accepts connections.
*/
readonly port: pulumi.Output<number | undefined>;
/**
* Attach a public IP to the customer ENI.
*/
readonly publiclyAccessible: pulumi.Output<boolean | undefined>;
/**
* The reader endpoint for the InfluxDB cluster.
*/
readonly readerEndpoint: pulumi.Output<string>;
/**
* Status of the InfluxDB cluster.
*/
readonly status: pulumi.Output<enums.timestream.InfluxDbClusterStatus>;
/**
* An arbitrary set of tags (key-value pairs) for this DB cluster.
*/
readonly tags: pulumi.Output<outputs.Tag[] | undefined>;
/**
* The username for the InfluxDB cluster.
*/
readonly username: pulumi.Output<string | undefined>;
/**
* A list of Amazon EC2 VPC security groups to associate with this InfluxDB cluster.
*/
readonly vpcSecurityGroupIds: pulumi.Output<string[] | undefined>;
/**
* A list of EC2 subnet IDs for this InfluxDB cluster.
*/
readonly vpcSubnetIds: pulumi.Output<string[] | undefined>;
/**
* Create a InfluxDbCluster resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args?: InfluxDbClusterArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a InfluxDbCluster resource.
*/
export interface InfluxDbClusterArgs {
/**
* The allocated storage for the InfluxDB cluster.
*/
allocatedStorage?: pulumi.Input<number>;
/**
* The bucket for the InfluxDB cluster.
*/
bucket?: pulumi.Input<string>;
/**
* The compute instance of the InfluxDB cluster.
*/
dbInstanceType?: pulumi.Input<enums.timestream.InfluxDbClusterDbInstanceType>;
/**
* The name of an existing InfluxDB parameter group.
*/
dbParameterGroupIdentifier?: pulumi.Input<string>;
/**
* The storage type of the InfluxDB cluster.
*/
dbStorageType?: pulumi.Input<enums.timestream.InfluxDbClusterDbStorageType>;
/**
* Deployment type of the InfluxDB cluster.
*/
deploymentType?: pulumi.Input<enums.timestream.InfluxDbClusterDeploymentType>;
/**
* Failover mode of the InfluxDB cluster.
*/
failoverMode?: pulumi.Input<enums.timestream.InfluxDbClusterFailoverMode>;
/**
* Configuration for sending logs to customer account from the InfluxDB cluster.
*/
logDeliveryConfiguration?: pulumi.Input<inputs.timestream.LogDeliveryConfigurationPropertiesArgs>;
/**
* The maintenance schedule for the InfluxDB cluster.
*/
maintenanceSchedule?: pulumi.Input<inputs.timestream.InfluxDbClusterMaintenanceScheduleArgs>;
/**
* The unique name that is associated with the InfluxDB cluster.
*/
name?: pulumi.Input<string>;
/**
* Network type of the InfluxDB cluster.
*/
networkType?: pulumi.Input<enums.timestream.InfluxDbClusterNetworkType>;
/**
* The organization for the InfluxDB cluster.
*/
organization?: pulumi.Input<string>;
/**
* The password for the InfluxDB cluster.
*/
password?: pulumi.Input<string>;
/**
* The port number on which InfluxDB accepts connections.
*/
port?: pulumi.Input<number>;
/**
* Attach a public IP to the customer ENI.
*/
publiclyAccessible?: pulumi.Input<boolean>;
/**
* An arbitrary set of tags (key-value pairs) for this DB cluster.
*/
tags?: pulumi.Input<pulumi.Input<inputs.TagArgs>[]>;
/**
* The username for the InfluxDB cluster.
*/
username?: pulumi.Input<string>;
/**
* A list of Amazon EC2 VPC security groups to associate with this InfluxDB cluster.
*/
vpcSecurityGroupIds?: pulumi.Input<pulumi.Input<string>[]>;
/**
* A list of EC2 subnet IDs for this InfluxDB cluster.
*/
vpcSubnetIds?: pulumi.Input<pulumi.Input<string>[]>;
}