docdbelastic

package
v0.106.0 Latest Latest
Warning

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

 Go to latest Published: May 20, 2024 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Cluster 

type Cluster struct {
	pulumi.CustomResourceState

	// The name of the Amazon DocumentDB elastic clusters administrator.
	//
	// *Constraints* :
	//
	// - Must be from 1 to 63 letters or numbers.
	// - The first character must be a letter.
	// - Cannot be a reserved word.
	AdminUserName pulumi.StringOutput `pulumi:"adminUserName"`
	// The password for the Elastic DocumentDB cluster administrator and can contain any printable ASCII characters.
	//
	// *Constraints* :
	//
	// - Must contain from 8 to 100 characters.
	// - Cannot contain a forward slash (/), double quote ("), or the "at" symbol (@).
	// - A valid `AdminUserName` entry is also required.
	AdminUserPassword pulumi.StringPtrOutput `pulumi:"adminUserPassword"`
	// The authentication type used to determine where to fetch the password used for accessing the elastic cluster. Valid types are `PLAIN_TEXT` or `SECRET_ARN` .
	AuthType pulumi.StringOutput `pulumi:"authType"`
	// The number of days for which automatic snapshots are retained.
	BackupRetentionPeriod pulumi.IntPtrOutput `pulumi:"backupRetentionPeriod"`
	ClusterArn            pulumi.StringOutput `pulumi:"clusterArn"`
	// The URL used to connect to the elastic cluster.
	ClusterEndpoint pulumi.StringOutput `pulumi:"clusterEndpoint"`
	// The name of the new elastic cluster. This parameter is stored as a lowercase string.
	//
	// *Constraints* :
	//
	// - Must contain from 1 to 63 letters, numbers, or hyphens.
	// - The first character must be a letter.
	// - Cannot end with a hyphen or contain two consecutive hyphens.
	//
	// *Example* : `my-cluster`
	ClusterName pulumi.StringOutput `pulumi:"clusterName"`
	// The KMS key identifier to use to encrypt the new elastic cluster.
	//
	// The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key.
	//
	// If an encryption key is not specified, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.
	KmsKeyId pulumi.StringPtrOutput `pulumi:"kmsKeyId"`
	// The daily time range during which automated backups are created if automated backups are enabled, as determined by `backupRetentionPeriod` .
	PreferredBackupWindow pulumi.StringPtrOutput `pulumi:"preferredBackupWindow"`
	// The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
	//
	// *Format* : `ddd:hh24:mi-ddd:hh24:mi`
	//
	// *Default* : a 30-minute window selected at random from an 8-hour block of time for each AWS Region , occurring on a random day of the week.
	//
	// *Valid days* : Mon, Tue, Wed, Thu, Fri, Sat, Sun
	//
	// *Constraints* : Minimum 30-minute window.
	PreferredMaintenanceWindow pulumi.StringPtrOutput `pulumi:"preferredMaintenanceWindow"`
	// The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.
	ShardCapacity pulumi.IntOutput `pulumi:"shardCapacity"`
	// The number of shards assigned to the elastic cluster. Maximum is 32.
	ShardCount pulumi.IntOutput `pulumi:"shardCount"`
	// The number of replica instances applying to all shards in the cluster. A `shardInstanceCount` value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.
	ShardInstanceCount pulumi.IntPtrOutput `pulumi:"shardInstanceCount"`
	// The Amazon EC2 subnet IDs for the new elastic cluster.
	SubnetIds pulumi.StringArrayOutput `pulumi:"subnetIds"`
	// The tags to be assigned to the new elastic cluster.
	Tags aws.TagArrayOutput `pulumi:"tags"`
	// A list of EC2 VPC security groups to associate with the new elastic cluster.
	VpcSecurityGroupIds pulumi.StringArrayOutput `pulumi:"vpcSecurityGroupIds"`
}

The AWS::DocDBElastic::Cluster Amazon DocumentDB (with MongoDB compatibility) Elastic Scale resource describes a Cluster

func GetCluster 

func GetCluster(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ClusterState, opts ...pulumi.ResourceOption) (*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 

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

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

func (*Cluster) ElementType 

func (*Cluster) ElementType() reflect.Type

func (*Cluster) ToClusterOutput 

func (i *Cluster) ToClusterOutput() ClusterOutput

func (*Cluster) ToClusterOutputWithContext 

func (i *Cluster) ToClusterOutputWithContext(ctx context.Context) ClusterOutput

type ClusterArgs 

type ClusterArgs struct {
	// The name of the Amazon DocumentDB elastic clusters administrator.
	//
	// *Constraints* :
	//
	// - Must be from 1 to 63 letters or numbers.
	// - The first character must be a letter.
	// - Cannot be a reserved word.
	AdminUserName pulumi.StringInput
	// The password for the Elastic DocumentDB cluster administrator and can contain any printable ASCII characters.
	//
	// *Constraints* :
	//
	// - Must contain from 8 to 100 characters.
	// - Cannot contain a forward slash (/), double quote ("), or the "at" symbol (@).
	// - A valid `AdminUserName` entry is also required.
	AdminUserPassword pulumi.StringPtrInput
	// The authentication type used to determine where to fetch the password used for accessing the elastic cluster. Valid types are `PLAIN_TEXT` or `SECRET_ARN` .
	AuthType pulumi.StringInput
	// The number of days for which automatic snapshots are retained.
	BackupRetentionPeriod pulumi.IntPtrInput
	// The name of the new elastic cluster. This parameter is stored as a lowercase string.
	//
	// *Constraints* :
	//
	// - Must contain from 1 to 63 letters, numbers, or hyphens.
	// - The first character must be a letter.
	// - Cannot end with a hyphen or contain two consecutive hyphens.
	//
	// *Example* : `my-cluster`
	ClusterName pulumi.StringPtrInput
	// The KMS key identifier to use to encrypt the new elastic cluster.
	//
	// The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key.
	//
	// If an encryption key is not specified, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.
	KmsKeyId pulumi.StringPtrInput
	// The daily time range during which automated backups are created if automated backups are enabled, as determined by `backupRetentionPeriod` .
	PreferredBackupWindow pulumi.StringPtrInput
	// The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
	//
	// *Format* : `ddd:hh24:mi-ddd:hh24:mi`
	//
	// *Default* : a 30-minute window selected at random from an 8-hour block of time for each AWS Region , occurring on a random day of the week.
	//
	// *Valid days* : Mon, Tue, Wed, Thu, Fri, Sat, Sun
	//
	// *Constraints* : Minimum 30-minute window.
	PreferredMaintenanceWindow pulumi.StringPtrInput
	// The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.
	ShardCapacity pulumi.IntInput
	// The number of shards assigned to the elastic cluster. Maximum is 32.
	ShardCount pulumi.IntInput
	// The number of replica instances applying to all shards in the cluster. A `shardInstanceCount` value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.
	ShardInstanceCount pulumi.IntPtrInput
	// The Amazon EC2 subnet IDs for the new elastic cluster.
	SubnetIds pulumi.StringArrayInput
	// The tags to be assigned to the new elastic cluster.
	Tags aws.TagArrayInput
	// A list of EC2 VPC security groups to associate with the new elastic cluster.
	VpcSecurityGroupIds pulumi.StringArrayInput
}

The set of arguments for constructing a Cluster resource.

func (ClusterArgs) ElementType 

func (ClusterArgs) ElementType() reflect.Type

type ClusterInput 

type ClusterInput interface {
	pulumi.Input

	ToClusterOutput() ClusterOutput
	ToClusterOutputWithContext(ctx context.Context) ClusterOutput
}

type ClusterOutput 

type ClusterOutput struct{ *pulumi.OutputState }

func (ClusterOutput) AdminUserName 

func (o ClusterOutput) AdminUserName() pulumi.StringOutput

The name of the Amazon DocumentDB elastic clusters administrator.

*Constraints* :

- Must be from 1 to 63 letters or numbers. - The first character must be a letter. - Cannot be a reserved word.

func (ClusterOutput) AdminUserPassword 

func (o ClusterOutput) AdminUserPassword() pulumi.StringPtrOutput

The password for the Elastic DocumentDB cluster administrator and can contain any printable ASCII characters.

*Constraints* :

- Must contain from 8 to 100 characters. - Cannot contain a forward slash (/), double quote ("), or the "at" symbol (@). - A valid `AdminUserName` entry is also required.

func (ClusterOutput) AuthType 

func (o ClusterOutput) AuthType() pulumi.StringOutput

The authentication type used to determine where to fetch the password used for accessing the elastic cluster. Valid types are `PLAIN_TEXT` or `SECRET_ARN` .

func (ClusterOutput) BackupRetentionPeriod added in v0.101.0 

func (o ClusterOutput) BackupRetentionPeriod() pulumi.IntPtrOutput

The number of days for which automatic snapshots are retained.

func (ClusterOutput) ClusterArn 

func (o ClusterOutput) ClusterArn() pulumi.StringOutput

func (ClusterOutput) ClusterEndpoint added in v0.53.0 

func (o ClusterOutput) ClusterEndpoint() pulumi.StringOutput

The URL used to connect to the elastic cluster.

func (ClusterOutput) ClusterName 

func (o ClusterOutput) ClusterName() pulumi.StringOutput

The name of the new elastic cluster. This parameter is stored as a lowercase string.

*Constraints* :

- Must contain from 1 to 63 letters, numbers, or hyphens. - The first character must be a letter. - Cannot end with a hyphen or contain two consecutive hyphens.

*Example* : `my-cluster`

func (ClusterOutput) ElementType 

func (ClusterOutput) ElementType() reflect.Type

func (ClusterOutput) KmsKeyId 

func (o ClusterOutput) KmsKeyId() pulumi.StringPtrOutput

The KMS key identifier to use to encrypt the new elastic cluster.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key.

If an encryption key is not specified, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.

func (ClusterOutput) PreferredBackupWindow added in v0.101.0 

func (o ClusterOutput) PreferredBackupWindow() pulumi.StringPtrOutput

The daily time range during which automated backups are created if automated backups are enabled, as determined by `backupRetentionPeriod` .

func (ClusterOutput) PreferredMaintenanceWindow 

func (o ClusterOutput) PreferredMaintenanceWindow() pulumi.StringPtrOutput

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

*Format* : `ddd:hh24:mi-ddd:hh24:mi`

*Default* : a 30-minute window selected at random from an 8-hour block of time for each AWS Region , occurring on a random day of the week.

*Valid days* : Mon, Tue, Wed, Thu, Fri, Sat, Sun

*Constraints* : Minimum 30-minute window.

func (ClusterOutput) ShardCapacity 

func (o ClusterOutput) ShardCapacity() pulumi.IntOutput

The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.

func (ClusterOutput) ShardCount 

func (o ClusterOutput) ShardCount() pulumi.IntOutput

The number of shards assigned to the elastic cluster. Maximum is 32.

func (ClusterOutput) ShardInstanceCount added in v0.101.0 

func (o ClusterOutput) ShardInstanceCount() pulumi.IntPtrOutput

The number of replica instances applying to all shards in the cluster. A `shardInstanceCount` value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

func (ClusterOutput) SubnetIds 

func (o ClusterOutput) SubnetIds() pulumi.StringArrayOutput

The Amazon EC2 subnet IDs for the new elastic cluster.

func (ClusterOutput) Tags 

func (o ClusterOutput) Tags() aws.TagArrayOutput

The tags to be assigned to the new elastic cluster.

func (ClusterOutput) ToClusterOutput 

func (o ClusterOutput) ToClusterOutput() ClusterOutput

func (ClusterOutput) ToClusterOutputWithContext 

func (o ClusterOutput) ToClusterOutputWithContext(ctx context.Context) ClusterOutput

func (ClusterOutput) VpcSecurityGroupIds 

func (o ClusterOutput) VpcSecurityGroupIds() pulumi.StringArrayOutput

A list of EC2 VPC security groups to associate with the new elastic cluster.

type ClusterState 

type ClusterState struct {
}

func (ClusterState) ElementType 

func (ClusterState) ElementType() reflect.Type

type ClusterTag 

type ClusterTag struct {
	Key   string `pulumi:"key"`
	Value string `pulumi:"value"`
}

type LookupClusterArgs 

type LookupClusterArgs struct {
	ClusterArn string `pulumi:"clusterArn"`
}

type LookupClusterOutputArgs 

type LookupClusterOutputArgs struct {
	ClusterArn pulumi.StringInput `pulumi:"clusterArn"`
}

func (LookupClusterOutputArgs) ElementType 

func (LookupClusterOutputArgs) ElementType() reflect.Type

type LookupClusterResult 

type LookupClusterResult struct {
	// The number of days for which automatic snapshots are retained.
	BackupRetentionPeriod *int    `pulumi:"backupRetentionPeriod"`
	ClusterArn            *string `pulumi:"clusterArn"`
	// The URL used to connect to the elastic cluster.
	ClusterEndpoint *string `pulumi:"clusterEndpoint"`
	// The daily time range during which automated backups are created if automated backups are enabled, as determined by `backupRetentionPeriod` .
	PreferredBackupWindow *string `pulumi:"preferredBackupWindow"`
	// The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
	//
	// *Format* : `ddd:hh24:mi-ddd:hh24:mi`
	//
	// *Default* : a 30-minute window selected at random from an 8-hour block of time for each AWS Region , occurring on a random day of the week.
	//
	// *Valid days* : Mon, Tue, Wed, Thu, Fri, Sat, Sun
	//
	// *Constraints* : Minimum 30-minute window.
	PreferredMaintenanceWindow *string `pulumi:"preferredMaintenanceWindow"`
	// The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.
	ShardCapacity *int `pulumi:"shardCapacity"`
	// The number of shards assigned to the elastic cluster. Maximum is 32.
	ShardCount *int `pulumi:"shardCount"`
	// The number of replica instances applying to all shards in the cluster. A `shardInstanceCount` value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.
	ShardInstanceCount *int `pulumi:"shardInstanceCount"`
	// The Amazon EC2 subnet IDs for the new elastic cluster.
	SubnetIds []string `pulumi:"subnetIds"`
	// The tags to be assigned to the new elastic cluster.
	Tags []aws.Tag `pulumi:"tags"`
	// A list of EC2 VPC security groups to associate with the new elastic cluster.
	VpcSecurityGroupIds []string `pulumi:"vpcSecurityGroupIds"`
}

func LookupCluster 

func LookupCluster(ctx *pulumi.Context, args *LookupClusterArgs, opts ...pulumi.InvokeOption) (*LookupClusterResult, error)

The AWS::DocDBElastic::Cluster Amazon DocumentDB (with MongoDB compatibility) Elastic Scale resource describes a Cluster

type LookupClusterResultOutput 

type LookupClusterResultOutput struct{ *pulumi.OutputState }

func LookupClusterOutput 

func LookupClusterOutput(ctx *pulumi.Context, args LookupClusterOutputArgs, opts ...pulumi.InvokeOption) LookupClusterResultOutput

func (LookupClusterResultOutput) BackupRetentionPeriod added in v0.101.0 

func (o LookupClusterResultOutput) BackupRetentionPeriod() pulumi.IntPtrOutput

The number of days for which automatic snapshots are retained.

func (LookupClusterResultOutput) ClusterArn 

func (o LookupClusterResultOutput) ClusterArn() pulumi.StringPtrOutput

func (LookupClusterResultOutput) ClusterEndpoint added in v0.53.0 

func (o LookupClusterResultOutput) ClusterEndpoint() pulumi.StringPtrOutput

The URL used to connect to the elastic cluster.

func (LookupClusterResultOutput) ElementType 

func (LookupClusterResultOutput) ElementType() reflect.Type

func (LookupClusterResultOutput) PreferredBackupWindow added in v0.101.0 

func (o LookupClusterResultOutput) PreferredBackupWindow() pulumi.StringPtrOutput

The daily time range during which automated backups are created if automated backups are enabled, as determined by `backupRetentionPeriod` .

func (LookupClusterResultOutput) PreferredMaintenanceWindow added in v0.53.0 

func (o LookupClusterResultOutput) PreferredMaintenanceWindow() pulumi.StringPtrOutput

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

*Format* : `ddd:hh24:mi-ddd:hh24:mi`

*Default* : a 30-minute window selected at random from an 8-hour block of time for each AWS Region , occurring on a random day of the week.

*Valid days* : Mon, Tue, Wed, Thu, Fri, Sat, Sun

*Constraints* : Minimum 30-minute window.

func (LookupClusterResultOutput) ShardCapacity 

func (o LookupClusterResultOutput) ShardCapacity() pulumi.IntPtrOutput

The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.

func (LookupClusterResultOutput) ShardCount 

func (o LookupClusterResultOutput) ShardCount() pulumi.IntPtrOutput

The number of shards assigned to the elastic cluster. Maximum is 32.

func (LookupClusterResultOutput) ShardInstanceCount added in v0.101.0 

func (o LookupClusterResultOutput) ShardInstanceCount() pulumi.IntPtrOutput

The number of replica instances applying to all shards in the cluster. A `shardInstanceCount` value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

func (LookupClusterResultOutput) SubnetIds 

func (o LookupClusterResultOutput) SubnetIds() pulumi.StringArrayOutput

The Amazon EC2 subnet IDs for the new elastic cluster.

func (LookupClusterResultOutput) Tags 

func (o LookupClusterResultOutput) Tags() aws.TagArrayOutput

The tags to be assigned to the new elastic cluster.

func (LookupClusterResultOutput) ToLookupClusterResultOutput 

func (o LookupClusterResultOutput) ToLookupClusterResultOutput() LookupClusterResultOutput

func (LookupClusterResultOutput) ToLookupClusterResultOutputWithContext 

func (o LookupClusterResultOutput) ToLookupClusterResultOutputWithContext(ctx context.Context) LookupClusterResultOutput

func (LookupClusterResultOutput) VpcSecurityGroupIds 

func (o LookupClusterResultOutput) VpcSecurityGroupIds() pulumi.StringArrayOutput

A list of EC2 VPC security groups to associate with the new elastic cluster.

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.