docdb

package
v0.18.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 5, 2019 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Cluster added in v0.16.8 

type Cluster struct {
	// contains filtered or unexported fields
}

Manages a DocDB Cluster.

Changes to a DocDB Cluster can occur when you manually change a parameter, such as `port`, and are reflected in the next maintenance window. Because of this, Terraform may report a difference in its planning phase because a modification has not yet taken place. You can use the `apply_immediately` flag to instruct the service to apply the change immediately (see documentation below).

> **Note:** using `apply_immediately` can result in a brief downtime as the server reboots. > **Note:** All arguments including the username and password will be stored in the raw state as plain-text. [Read more about sensitive data in state](https://www.terraform.io/docs/state/sensitive-data.html).

func GetCluster added in v0.16.8 

func GetCluster(ctx *pulumi.Context,
	name string, id pulumi.ID, state *ClusterState, opts ...pulumi.ResourceOpt) (*Cluster, error)

GetCluster gets an existing Cluster resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewCluster added in v0.16.8 

func NewCluster(ctx *pulumi.Context,
	name string, args *ClusterArgs, opts ...pulumi.ResourceOpt) (*Cluster, error)

NewCluster registers a new resource with the given unique name, arguments, and options.

func (*Cluster) ApplyImmediately added in v0.16.8 

func (r *Cluster) ApplyImmediately() *pulumi.BoolOutput

Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is `false`.

func (*Cluster) Arn added in v0.16.8 

func (r *Cluster) Arn() *pulumi.StringOutput

Amazon Resource Name (ARN) of cluster

func (*Cluster) AvailabilityZones added in v0.16.8 

func (r *Cluster) AvailabilityZones() *pulumi.ArrayOutput

A list of EC2 Availability Zones that instances in the DB cluster can be created in.

func (*Cluster) BackupRetentionPeriod added in v0.16.8 

func (r *Cluster) BackupRetentionPeriod() *pulumi.IntOutput

The days to retain backups for. Default `1`

func (*Cluster) ClusterIdentifier added in v0.16.8 

func (r *Cluster) ClusterIdentifier() *pulumi.StringOutput

The cluster identifier. If omitted, Terraform will assign a random, unique identifier.

func (*Cluster) ClusterIdentifierPrefix added in v0.16.8 

func (r *Cluster) ClusterIdentifierPrefix() *pulumi.StringOutput

Creates a unique cluster identifier beginning with the specified prefix. Conflicts with `cluster_identifer`.

func (*Cluster) ClusterMembers added in v0.16.8 

func (r *Cluster) ClusterMembers() *pulumi.ArrayOutput

List of DocDB Instances that are a part of this cluster

func (*Cluster) ClusterResourceId added in v0.16.8 

func (r *Cluster) ClusterResourceId() *pulumi.StringOutput

The DocDB Cluster Resource ID

func (*Cluster) DbClusterParameterGroupName added in v0.16.8 

func (r *Cluster) DbClusterParameterGroupName() *pulumi.StringOutput

A cluster parameter group to associate with the cluster.

func (*Cluster) DbSubnetGroupName added in v0.16.8 

func (r *Cluster) DbSubnetGroupName() *pulumi.StringOutput

A DB subnet group to associate with this DB instance.

func (*Cluster) EnabledCloudwatchLogsExports added in v0.16.8 

func (r *Cluster) EnabledCloudwatchLogsExports() *pulumi.ArrayOutput

List of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: `audit`.

func (*Cluster) Endpoint added in v0.16.8 

func (r *Cluster) Endpoint() *pulumi.StringOutput

The DNS address of the DocDB instance

func (*Cluster) Engine added in v0.16.8 

func (r *Cluster) Engine() *pulumi.StringOutput

The name of the database engine to be used for this DB cluster. Defaults to `docdb`. Valid Values: `docdb`

func (*Cluster) EngineVersion added in v0.16.8 

func (r *Cluster) EngineVersion() *pulumi.StringOutput

The database engine version. Updating this argument results in an outage.

func (*Cluster) FinalSnapshotIdentifier added in v0.16.8 

func (r *Cluster) FinalSnapshotIdentifier() *pulumi.StringOutput

The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.

func (*Cluster) HostedZoneId added in v0.16.8 

func (r *Cluster) HostedZoneId() *pulumi.StringOutput

The Route53 Hosted Zone ID of the endpoint

func (*Cluster) ID added in v0.16.8 

func (r *Cluster) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*Cluster) KmsKeyId added in v0.16.8 

func (r *Cluster) KmsKeyId() *pulumi.StringOutput

The ARN for the KMS encryption key. When specifying `kms_key_id`, `storage_encrypted` needs to be set to true.

func (*Cluster) MasterPassword added in v0.16.8 

func (r *Cluster) MasterPassword() *pulumi.StringOutput

Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Please refer to the DocDB Naming Constraints.

func (*Cluster) MasterUsername added in v0.16.8 

func (r *Cluster) MasterUsername() *pulumi.StringOutput

Username for the master DB user.

func (*Cluster) Port added in v0.16.8 

func (r *Cluster) Port() *pulumi.IntOutput

The port on which the DB accepts connections

func (*Cluster) PreferredBackupWindow added in v0.16.8 

func (r *Cluster) PreferredBackupWindow() *pulumi.StringOutput

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.Time in UTC Default: A 30-minute window selected at random from an 8-hour block of time per region. e.g. 04:00-09:00

func (*Cluster) PreferredMaintenanceWindow added in v0.16.8 

func (r *Cluster) PreferredMaintenanceWindow() *pulumi.StringOutput

func (*Cluster) ReaderEndpoint added in v0.16.8 

func (r *Cluster) ReaderEndpoint() *pulumi.StringOutput

A read-only endpoint for the DocDB cluster, automatically load-balanced across replicas

func (*Cluster) SkipFinalSnapshot added in v0.16.8 

func (r *Cluster) SkipFinalSnapshot() *pulumi.BoolOutput

Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from `final_snapshot_identifier`. Default is `false`.

func (*Cluster) SnapshotIdentifier added in v0.16.8 

func (r *Cluster) SnapshotIdentifier() *pulumi.StringOutput

Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot.

func (*Cluster) StorageEncrypted added in v0.16.8 

func (r *Cluster) StorageEncrypted() *pulumi.BoolOutput

Specifies whether the DB cluster is encrypted. The default is `false`.

func (*Cluster) Tags added in v0.16.8 

func (r *Cluster) Tags() *pulumi.MapOutput

A mapping of tags to assign to the DB cluster.

func (*Cluster) URN added in v0.16.8 

func (r *Cluster) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

func (*Cluster) VpcSecurityGroupIds added in v0.16.8 

func (r *Cluster) VpcSecurityGroupIds() *pulumi.ArrayOutput

List of VPC security groups to associate with the Cluster

type ClusterArgs added in v0.16.8 

type ClusterArgs struct {
	// Specifies whether any cluster modifications
	// are applied immediately, or during the next maintenance window. Default is
	// `false`.
	ApplyImmediately interface{}
	// A list of EC2 Availability Zones that
	// instances in the DB cluster can be created in.
	AvailabilityZones interface{}
	// The days to retain backups for. Default `1`
	BackupRetentionPeriod interface{}
	// The cluster identifier. If omitted, Terraform will assign a random, unique identifier.
	ClusterIdentifier interface{}
	// Creates a unique cluster identifier beginning with the specified prefix. Conflicts with `cluster_identifer`.
	ClusterIdentifierPrefix interface{}
	// List of DocDB Instances that are a part of this cluster
	ClusterMembers interface{}
	// A cluster parameter group to associate with the cluster.
	DbClusterParameterGroupName interface{}
	// A DB subnet group to associate with this DB instance.
	DbSubnetGroupName interface{}
	// List of log types to export to cloudwatch. If omitted, no logs will be exported.
	// The following log types are supported: `audit`.
	EnabledCloudwatchLogsExports interface{}
	// The name of the database engine to be used for this DB cluster. Defaults to `docdb`. Valid Values: `docdb`
	Engine interface{}
	// The database engine version. Updating this argument results in an outage.
	EngineVersion interface{}
	// The name of your final DB snapshot
	// when this DB cluster is deleted. If omitted, no final snapshot will be
	// made.
	FinalSnapshotIdentifier interface{}
	// The ARN for the KMS encryption key. When specifying `kms_key_id`, `storage_encrypted` needs to be set to true.
	KmsKeyId interface{}
	// Password for the master DB user. Note that this may
	// show up in logs, and it will be stored in the state file. Please refer to the DocDB Naming Constraints.
	MasterPassword interface{}
	// Username for the master DB user.
	MasterUsername interface{}
	// The port on which the DB accepts connections
	Port interface{}
	// The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.Time in UTC
	// Default: A 30-minute window selected at random from an 8-hour block of time per region. e.g. 04:00-09:00
	PreferredBackupWindow      interface{}
	PreferredMaintenanceWindow interface{}
	// Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from `final_snapshot_identifier`. Default is `false`.
	SkipFinalSnapshot interface{}
	// Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot.
	SnapshotIdentifier interface{}
	// Specifies whether the DB cluster is encrypted. The default is `false`.
	StorageEncrypted interface{}
	// A mapping of tags to assign to the DB cluster.
	Tags interface{}
	// List of VPC security groups to associate
	// with the Cluster
	VpcSecurityGroupIds interface{}
}

The set of arguments for constructing a Cluster resource.

type ClusterInstance added in v0.16.9 

type ClusterInstance struct {
	// contains filtered or unexported fields
}

Provides an DocDB Cluster Resource Instance. A Cluster Instance Resource defines attributes that are specific to a single instance in a [DocDB Cluster][1].

You do not designate a primary and subsequent replicas. Instead, you simply add DocDB Instances and DocDB manages the replication. You can use the [count][3] meta-parameter to make multiple instances and join them all to the same DocDB Cluster, or you may specify different Cluster Instance resources with various `instance_class` sizes.

func GetClusterInstance added in v0.16.9 

func GetClusterInstance(ctx *pulumi.Context,
	name string, id pulumi.ID, state *ClusterInstanceState, opts ...pulumi.ResourceOpt) (*ClusterInstance, error)

GetClusterInstance gets an existing ClusterInstance resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewClusterInstance added in v0.16.9 

func NewClusterInstance(ctx *pulumi.Context,
	name string, args *ClusterInstanceArgs, opts ...pulumi.ResourceOpt) (*ClusterInstance, error)

NewClusterInstance registers a new resource with the given unique name, arguments, and options.

func (*ClusterInstance) ApplyImmediately added in v0.16.9 

func (r *ClusterInstance) ApplyImmediately() *pulumi.BoolOutput

Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default is`false`.

func (*ClusterInstance) Arn added in v0.16.9 

func (r *ClusterInstance) Arn() *pulumi.StringOutput

Amazon Resource Name (ARN) of cluster instance

func (*ClusterInstance) AutoMinorVersionUpgrade added in v0.16.9 

func (r *ClusterInstance) AutoMinorVersionUpgrade() *pulumi.BoolOutput

Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Default `true`.

func (*ClusterInstance) AvailabilityZone added in v0.16.9 

func (r *ClusterInstance) AvailabilityZone() *pulumi.StringOutput

The EC2 Availability Zone that the DB instance is created in. See [docs](https://docs.aws.amazon.com/AmazonDocDB/latest/APIReference/API_CreateDBInstance.html) about the details.

func (*ClusterInstance) ClusterIdentifier added in v0.16.9 

func (r *ClusterInstance) ClusterIdentifier() *pulumi.StringOutput

The identifier of the [`aws_docdb_cluster`](https://www.terraform.io/docs/providers/aws/r/docdb_cluster.html) in which to launch this instance.

func (*ClusterInstance) DbSubnetGroupName added in v0.16.9 

func (r *ClusterInstance) DbSubnetGroupName() *pulumi.StringOutput

The DB subnet group to associate with this DB instance.

func (*ClusterInstance) DbiResourceId added in v0.16.9 

func (r *ClusterInstance) DbiResourceId() *pulumi.StringOutput

The region-unique, immutable identifier for the DB instance.

func (*ClusterInstance) Endpoint added in v0.16.9 

func (r *ClusterInstance) Endpoint() *pulumi.StringOutput

The DNS address for this instance. May not be writable

func (*ClusterInstance) Engine added in v0.16.9 

func (r *ClusterInstance) Engine() *pulumi.StringOutput

The name of the database engine to be used for the DocDB instance. Defaults to `docdb`. Valid Values: `docdb`.

func (*ClusterInstance) EngineVersion added in v0.16.9 

func (r *ClusterInstance) EngineVersion() *pulumi.StringOutput

The database engine version

func (*ClusterInstance) ID added in v0.16.9 

func (r *ClusterInstance) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*ClusterInstance) Identifier added in v0.16.9 

func (r *ClusterInstance) Identifier() *pulumi.StringOutput

The indentifier for the DocDB instance, if omitted, Terraform will assign a random, unique identifier.

func (*ClusterInstance) IdentifierPrefix added in v0.16.9 

func (r *ClusterInstance) IdentifierPrefix() *pulumi.StringOutput

Creates a unique identifier beginning with the specified prefix. Conflicts with `identifer`.

func (*ClusterInstance) InstanceClass added in v0.16.9 

func (r *ClusterInstance) InstanceClass() *pulumi.StringOutput

The instance class to use. For details on CPU and memory, see [Scaling for DocDB Instances][2]. DocDB currently supports the below instance classes. Please see [AWS Documentation][4] for complete details. - db.r4.large - db.r4.xlarge - db.r4.2xlarge - db.r4.4xlarge - db.r4.8xlarge - db.r4.16xlarge

func (*ClusterInstance) KmsKeyId added in v0.16.9 

func (r *ClusterInstance) KmsKeyId() *pulumi.StringOutput

The ARN for the KMS encryption key if one is set to the cluster.

func (*ClusterInstance) Port added in v0.16.9 

func (r *ClusterInstance) Port() *pulumi.IntOutput

The database port

func (*ClusterInstance) PreferredBackupWindow added in v0.16.9 

func (r *ClusterInstance) PreferredBackupWindow() *pulumi.StringOutput

The daily time range during which automated backups are created if automated backups are enabled.

func (*ClusterInstance) PreferredMaintenanceWindow added in v0.16.9 

func (r *ClusterInstance) PreferredMaintenanceWindow() *pulumi.StringOutput

The window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".

func (*ClusterInstance) PromotionTier added in v0.16.9 

func (r *ClusterInstance) PromotionTier() *pulumi.IntOutput

Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoter to writer.

func (*ClusterInstance) PubliclyAccessible added in v0.16.9 

func (r *ClusterInstance) PubliclyAccessible() *pulumi.BoolOutput

func (*ClusterInstance) StorageEncrypted added in v0.16.9 

func (r *ClusterInstance) StorageEncrypted() *pulumi.BoolOutput

Specifies whether the DB cluster is encrypted.

func (*ClusterInstance) Tags added in v0.16.9 

func (r *ClusterInstance) Tags() *pulumi.MapOutput

A mapping of tags to assign to the instance.

func (*ClusterInstance) URN added in v0.16.9 

func (r *ClusterInstance) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

func (*ClusterInstance) Writer added in v0.16.9 

func (r *ClusterInstance) Writer() *pulumi.BoolOutput

Boolean indicating if this instance is writable. `False` indicates this instance is a read replica.

type ClusterInstanceArgs added in v0.16.9 

type ClusterInstanceArgs struct {
	// Specifies whether any database modifications
	// are applied immediately, or during the next maintenance window. Default is`false`.
	ApplyImmediately interface{}
	// Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Default `true`.
	AutoMinorVersionUpgrade interface{}
	// The EC2 Availability Zone that the DB instance is created in. See [docs](https://docs.aws.amazon.com/AmazonDocDB/latest/APIReference/API_CreateDBInstance.html) about the details.
	AvailabilityZone interface{}
	// The identifier of the [`aws_docdb_cluster`](https://www.terraform.io/docs/providers/aws/r/docdb_cluster.html) in which to launch this instance.
	ClusterIdentifier interface{}
	// The name of the database engine to be used for the DocDB instance. Defaults to `docdb`. Valid Values: `docdb`.
	Engine interface{}
	// The indentifier for the DocDB instance, if omitted, Terraform will assign a random, unique identifier.
	Identifier interface{}
	// Creates a unique identifier beginning with the specified prefix. Conflicts with `identifer`.
	IdentifierPrefix interface{}
	// The instance class to use. For details on CPU and memory, see [Scaling for DocDB Instances][2]. DocDB currently
	// supports the below instance classes. Please see [AWS Documentation][4] for complete details.
	// - db.r4.large
	// - db.r4.xlarge
	// - db.r4.2xlarge
	// - db.r4.4xlarge
	// - db.r4.8xlarge
	// - db.r4.16xlarge
	InstanceClass interface{}
	// The window to perform maintenance in.
	// Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".
	PreferredMaintenanceWindow interface{}
	// Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoter to writer.
	PromotionTier interface{}
	// A mapping of tags to assign to the instance.
	Tags interface{}
}

The set of arguments for constructing a ClusterInstance resource.

type ClusterInstanceState added in v0.16.9 

type ClusterInstanceState struct {
	// Specifies whether any database modifications
	// are applied immediately, or during the next maintenance window. Default is`false`.
	ApplyImmediately interface{}
	// Amazon Resource Name (ARN) of cluster instance
	Arn interface{}
	// Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Default `true`.
	AutoMinorVersionUpgrade interface{}
	// The EC2 Availability Zone that the DB instance is created in. See [docs](https://docs.aws.amazon.com/AmazonDocDB/latest/APIReference/API_CreateDBInstance.html) about the details.
	AvailabilityZone interface{}
	// The identifier of the [`aws_docdb_cluster`](https://www.terraform.io/docs/providers/aws/r/docdb_cluster.html) in which to launch this instance.
	ClusterIdentifier interface{}
	// The DB subnet group to associate with this DB instance.
	DbSubnetGroupName interface{}
	// The region-unique, immutable identifier for the DB instance.
	DbiResourceId interface{}
	// The DNS address for this instance. May not be writable
	Endpoint interface{}
	// The name of the database engine to be used for the DocDB instance. Defaults to `docdb`. Valid Values: `docdb`.
	Engine interface{}
	// The database engine version
	EngineVersion interface{}
	// The indentifier for the DocDB instance, if omitted, Terraform will assign a random, unique identifier.
	Identifier interface{}
	// Creates a unique identifier beginning with the specified prefix. Conflicts with `identifer`.
	IdentifierPrefix interface{}
	// The instance class to use. For details on CPU and memory, see [Scaling for DocDB Instances][2]. DocDB currently
	// supports the below instance classes. Please see [AWS Documentation][4] for complete details.
	// - db.r4.large
	// - db.r4.xlarge
	// - db.r4.2xlarge
	// - db.r4.4xlarge
	// - db.r4.8xlarge
	// - db.r4.16xlarge
	InstanceClass interface{}
	// The ARN for the KMS encryption key if one is set to the cluster.
	KmsKeyId interface{}
	// The database port
	Port interface{}
	// The daily time range during which automated backups are created if automated backups are enabled.
	PreferredBackupWindow interface{}
	// The window to perform maintenance in.
	// Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".
	PreferredMaintenanceWindow interface{}
	// Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoter to writer.
	PromotionTier      interface{}
	PubliclyAccessible interface{}
	// Specifies whether the DB cluster is encrypted.
	StorageEncrypted interface{}
	// A mapping of tags to assign to the instance.
	Tags interface{}
	// Boolean indicating if this instance is writable. `False` indicates this instance is a read replica.
	Writer interface{}
}

Input properties used for looking up and filtering ClusterInstance resources.

type ClusterParameterGroup 

type ClusterParameterGroup struct {
	// contains filtered or unexported fields
}

Manages a DocumentDB Cluster Parameter Group

func GetClusterParameterGroup 

func GetClusterParameterGroup(ctx *pulumi.Context,
	name string, id pulumi.ID, state *ClusterParameterGroupState, opts ...pulumi.ResourceOpt) (*ClusterParameterGroup, error)

GetClusterParameterGroup gets an existing ClusterParameterGroup resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewClusterParameterGroup 

func NewClusterParameterGroup(ctx *pulumi.Context,
	name string, args *ClusterParameterGroupArgs, opts ...pulumi.ResourceOpt) (*ClusterParameterGroup, error)

NewClusterParameterGroup registers a new resource with the given unique name, arguments, and options.

func (*ClusterParameterGroup) Arn 

func (r *ClusterParameterGroup) Arn() *pulumi.StringOutput

The ARN of the documentDB cluster parameter group.

func (*ClusterParameterGroup) Description 

func (r *ClusterParameterGroup) Description() *pulumi.StringOutput

The description of the documentDB cluster parameter group. Defaults to "Managed by Terraform".

func (*ClusterParameterGroup) Family 

func (r *ClusterParameterGroup) Family() *pulumi.StringOutput

The family of the documentDB cluster parameter group.

func (*ClusterParameterGroup) ID 

func (r *ClusterParameterGroup) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*ClusterParameterGroup) Name 

func (r *ClusterParameterGroup) Name() *pulumi.StringOutput

The name of the documentDB parameter.

func (*ClusterParameterGroup) NamePrefix 

func (r *ClusterParameterGroup) NamePrefix() *pulumi.StringOutput

Creates a unique name beginning with the specified prefix. Conflicts with `name`.

func (*ClusterParameterGroup) Parameters 

func (r *ClusterParameterGroup) Parameters() *pulumi.ArrayOutput

A list of documentDB parameters to apply.

func (*ClusterParameterGroup) Tags 

func (r *ClusterParameterGroup) Tags() *pulumi.MapOutput

A mapping of tags to assign to the resource.

func (*ClusterParameterGroup) URN 

func (r *ClusterParameterGroup) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type ClusterParameterGroupArgs 

type ClusterParameterGroupArgs struct {
	// The description of the documentDB cluster parameter group. Defaults to "Managed by Terraform".
	Description interface{}
	// The family of the documentDB cluster parameter group.
	Family interface{}
	// The name of the documentDB parameter.
	Name interface{}
	// Creates a unique name beginning with the specified prefix. Conflicts with `name`.
	NamePrefix interface{}
	// A list of documentDB parameters to apply.
	Parameters interface{}
	// A mapping of tags to assign to the resource.
	Tags interface{}
}

The set of arguments for constructing a ClusterParameterGroup resource.

type ClusterParameterGroupState 

type ClusterParameterGroupState struct {
	// The ARN of the documentDB cluster parameter group.
	Arn interface{}
	// The description of the documentDB cluster parameter group. Defaults to "Managed by Terraform".
	Description interface{}
	// The family of the documentDB cluster parameter group.
	Family interface{}
	// The name of the documentDB parameter.
	Name interface{}
	// Creates a unique name beginning with the specified prefix. Conflicts with `name`.
	NamePrefix interface{}
	// A list of documentDB parameters to apply.
	Parameters interface{}
	// A mapping of tags to assign to the resource.
	Tags interface{}
}

Input properties used for looking up and filtering ClusterParameterGroup resources.

type ClusterSnapshot added in v0.16.8 

type ClusterSnapshot struct {
	// contains filtered or unexported fields
}

Manages a DocDB database cluster snapshot for DocDB clusters.

func GetClusterSnapshot added in v0.16.8 

func GetClusterSnapshot(ctx *pulumi.Context,
	name string, id pulumi.ID, state *ClusterSnapshotState, opts ...pulumi.ResourceOpt) (*ClusterSnapshot, error)

GetClusterSnapshot gets an existing ClusterSnapshot resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewClusterSnapshot added in v0.16.8 

func NewClusterSnapshot(ctx *pulumi.Context,
	name string, args *ClusterSnapshotArgs, opts ...pulumi.ResourceOpt) (*ClusterSnapshot, error)

NewClusterSnapshot registers a new resource with the given unique name, arguments, and options.

func (*ClusterSnapshot) AvailabilityZones added in v0.16.8 

func (r *ClusterSnapshot) AvailabilityZones() *pulumi.ArrayOutput

List of EC2 Availability Zones that instances in the DocDB cluster snapshot can be restored in.

func (*ClusterSnapshot) DbClusterIdentifier added in v0.16.8 

func (r *ClusterSnapshot) DbClusterIdentifier() *pulumi.StringOutput

The DocDB Cluster Identifier from which to take the snapshot.

func (*ClusterSnapshot) DbClusterSnapshotArn added in v0.16.8 

func (r *ClusterSnapshot) DbClusterSnapshotArn() *pulumi.StringOutput

The Amazon Resource Name (ARN) for the DocDB Cluster Snapshot.

func (*ClusterSnapshot) DbClusterSnapshotIdentifier added in v0.16.8 

func (r *ClusterSnapshot) DbClusterSnapshotIdentifier() *pulumi.StringOutput

The Identifier for the snapshot.

func (*ClusterSnapshot) Engine added in v0.16.8 

func (r *ClusterSnapshot) Engine() *pulumi.StringOutput

Specifies the name of the database engine.

func (*ClusterSnapshot) EngineVersion added in v0.16.8 

func (r *ClusterSnapshot) EngineVersion() *pulumi.StringOutput

Version of the database engine for this DocDB cluster snapshot.

func (*ClusterSnapshot) ID added in v0.16.8 

func (r *ClusterSnapshot) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*ClusterSnapshot) KmsKeyId added in v0.16.8 

func (r *ClusterSnapshot) KmsKeyId() *pulumi.StringOutput

If storage_encrypted is true, the AWS KMS key identifier for the encrypted DocDB cluster snapshot.

func (*ClusterSnapshot) Port added in v0.16.8 

func (r *ClusterSnapshot) Port() *pulumi.IntOutput

Port that the DocDB cluster was listening on at the time of the snapshot.

func (*ClusterSnapshot) SnapshotType added in v0.16.8 

func (r *ClusterSnapshot) SnapshotType() *pulumi.StringOutput

func (*ClusterSnapshot) SourceDbClusterSnapshotArn added in v0.16.8 

func (r *ClusterSnapshot) SourceDbClusterSnapshotArn() *pulumi.StringOutput

func (*ClusterSnapshot) Status added in v0.16.8 

func (r *ClusterSnapshot) Status() *pulumi.StringOutput

The status of this DocDB Cluster Snapshot.

func (*ClusterSnapshot) StorageEncrypted added in v0.16.8 

func (r *ClusterSnapshot) StorageEncrypted() *pulumi.BoolOutput

Specifies whether the DocDB cluster snapshot is encrypted.

func (*ClusterSnapshot) URN added in v0.16.8 

func (r *ClusterSnapshot) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

func (*ClusterSnapshot) VpcId added in v0.16.8 

func (r *ClusterSnapshot) VpcId() *pulumi.StringOutput

The VPC ID associated with the DocDB cluster snapshot.

type ClusterSnapshotArgs added in v0.16.8 

type ClusterSnapshotArgs struct {
	// The DocDB Cluster Identifier from which to take the snapshot.
	DbClusterIdentifier interface{}
	// The Identifier for the snapshot.
	DbClusterSnapshotIdentifier interface{}
}

The set of arguments for constructing a ClusterSnapshot resource.

type ClusterSnapshotState added in v0.16.8 

type ClusterSnapshotState struct {
	// List of EC2 Availability Zones that instances in the DocDB cluster snapshot can be restored in.
	AvailabilityZones interface{}
	// The DocDB Cluster Identifier from which to take the snapshot.
	DbClusterIdentifier interface{}
	// The Amazon Resource Name (ARN) for the DocDB Cluster Snapshot.
	DbClusterSnapshotArn interface{}
	// The Identifier for the snapshot.
	DbClusterSnapshotIdentifier interface{}
	// Specifies the name of the database engine.
	Engine interface{}
	// Version of the database engine for this DocDB cluster snapshot.
	EngineVersion interface{}
	// If storage_encrypted is true, the AWS KMS key identifier for the encrypted DocDB cluster snapshot.
	KmsKeyId interface{}
	// Port that the DocDB cluster was listening on at the time of the snapshot.
	Port                       interface{}
	SnapshotType               interface{}
	SourceDbClusterSnapshotArn interface{}
	// The status of this DocDB Cluster Snapshot.
	Status interface{}
	// Specifies whether the DocDB cluster snapshot is encrypted.
	StorageEncrypted interface{}
	// The VPC ID associated with the DocDB cluster snapshot.
	VpcId interface{}
}

Input properties used for looking up and filtering ClusterSnapshot resources.

type ClusterState added in v0.16.8 

type ClusterState struct {
	// Specifies whether any cluster modifications
	// are applied immediately, or during the next maintenance window. Default is
	// `false`.
	ApplyImmediately interface{}
	// Amazon Resource Name (ARN) of cluster
	Arn interface{}
	// A list of EC2 Availability Zones that
	// instances in the DB cluster can be created in.
	AvailabilityZones interface{}
	// The days to retain backups for. Default `1`
	BackupRetentionPeriod interface{}
	// The cluster identifier. If omitted, Terraform will assign a random, unique identifier.
	ClusterIdentifier interface{}
	// Creates a unique cluster identifier beginning with the specified prefix. Conflicts with `cluster_identifer`.
	ClusterIdentifierPrefix interface{}
	// List of DocDB Instances that are a part of this cluster
	ClusterMembers interface{}
	// The DocDB Cluster Resource ID
	ClusterResourceId interface{}
	// A cluster parameter group to associate with the cluster.
	DbClusterParameterGroupName interface{}
	// A DB subnet group to associate with this DB instance.
	DbSubnetGroupName interface{}
	// List of log types to export to cloudwatch. If omitted, no logs will be exported.
	// The following log types are supported: `audit`.
	EnabledCloudwatchLogsExports interface{}
	// The DNS address of the DocDB instance
	Endpoint interface{}
	// The name of the database engine to be used for this DB cluster. Defaults to `docdb`. Valid Values: `docdb`
	Engine interface{}
	// The database engine version. Updating this argument results in an outage.
	EngineVersion interface{}
	// The name of your final DB snapshot
	// when this DB cluster is deleted. If omitted, no final snapshot will be
	// made.
	FinalSnapshotIdentifier interface{}
	// The Route53 Hosted Zone ID of the endpoint
	HostedZoneId interface{}
	// The ARN for the KMS encryption key. When specifying `kms_key_id`, `storage_encrypted` needs to be set to true.
	KmsKeyId interface{}
	// Password for the master DB user. Note that this may
	// show up in logs, and it will be stored in the state file. Please refer to the DocDB Naming Constraints.
	MasterPassword interface{}
	// Username for the master DB user.
	MasterUsername interface{}
	// The port on which the DB accepts connections
	Port interface{}
	// The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.Time in UTC
	// Default: A 30-minute window selected at random from an 8-hour block of time per region. e.g. 04:00-09:00
	PreferredBackupWindow      interface{}
	PreferredMaintenanceWindow interface{}
	// A read-only endpoint for the DocDB cluster, automatically load-balanced across replicas
	ReaderEndpoint interface{}
	// Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from `final_snapshot_identifier`. Default is `false`.
	SkipFinalSnapshot interface{}
	// Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot.
	SnapshotIdentifier interface{}
	// Specifies whether the DB cluster is encrypted. The default is `false`.
	StorageEncrypted interface{}
	// A mapping of tags to assign to the DB cluster.
	Tags interface{}
	// List of VPC security groups to associate
	// with the Cluster
	VpcSecurityGroupIds interface{}
}

Input properties used for looking up and filtering Cluster resources.

type SubnetGroup 

type SubnetGroup struct {
	// contains filtered or unexported fields
}

Provides an DocumentDB subnet group resource.

func GetSubnetGroup 

func GetSubnetGroup(ctx *pulumi.Context,
	name string, id pulumi.ID, state *SubnetGroupState, opts ...pulumi.ResourceOpt) (*SubnetGroup, error)

GetSubnetGroup gets an existing SubnetGroup resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewSubnetGroup 

func NewSubnetGroup(ctx *pulumi.Context,
	name string, args *SubnetGroupArgs, opts ...pulumi.ResourceOpt) (*SubnetGroup, error)

NewSubnetGroup registers a new resource with the given unique name, arguments, and options.

func (*SubnetGroup) Arn 

func (r *SubnetGroup) Arn() *pulumi.StringOutput

The ARN of the docDB subnet group.

func (*SubnetGroup) Description 

func (r *SubnetGroup) Description() *pulumi.StringOutput

The description of the docDB subnet group. Defaults to "Managed by Terraform".

func (*SubnetGroup) ID 

func (r *SubnetGroup) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*SubnetGroup) Name 

func (r *SubnetGroup) Name() *pulumi.StringOutput

The name of the docDB subnet group. If omitted, Terraform will assign a random, unique name.

func (*SubnetGroup) NamePrefix 

func (r *SubnetGroup) NamePrefix() *pulumi.StringOutput

Creates a unique name beginning with the specified prefix. Conflicts with `name`.

func (*SubnetGroup) SubnetIds 

func (r *SubnetGroup) SubnetIds() *pulumi.ArrayOutput

A list of VPC subnet IDs.

func (*SubnetGroup) Tags 

func (r *SubnetGroup) Tags() *pulumi.MapOutput

A mapping of tags to assign to the resource.

func (*SubnetGroup) URN 

func (r *SubnetGroup) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type SubnetGroupArgs 

type SubnetGroupArgs struct {
	// The description of the docDB subnet group. Defaults to "Managed by Terraform".
	Description interface{}
	// The name of the docDB subnet group. If omitted, Terraform will assign a random, unique name.
	Name interface{}
	// Creates a unique name beginning with the specified prefix. Conflicts with `name`.
	NamePrefix interface{}
	// A list of VPC subnet IDs.
	SubnetIds interface{}
	// A mapping of tags to assign to the resource.
	Tags interface{}
}

The set of arguments for constructing a SubnetGroup resource.

type SubnetGroupState 

type SubnetGroupState struct {
	// The ARN of the docDB subnet group.
	Arn interface{}
	// The description of the docDB subnet group. Defaults to "Managed by Terraform".
	Description interface{}
	// The name of the docDB subnet group. If omitted, Terraform will assign a random, unique name.
	Name interface{}
	// Creates a unique name beginning with the specified prefix. Conflicts with `name`.
	NamePrefix interface{}
	// A list of VPC subnet IDs.
	SubnetIds interface{}
	// A mapping of tags to assign to the resource.
	Tags interface{}
}

Input properties used for looking up and filtering SubnetGroup resources.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.