This page documents the language specification for the aws package. If you're looking for help working with the inputs, outputs, or functions of aws resources in a Pulumi program, please see the resource documentation for examples and API reference.

docdb¶

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.

class pulumi_aws.docdb.Cluster(resource_name, opts=None, apply_immediately=None, availability_zones=None, backup_retention_period=None, cluster_identifier=None, cluster_identifier_prefix=None, cluster_members=None, db_cluster_parameter_group_name=None, db_subnet_group_name=None, deletion_protection=None, enabled_cloudwatch_logs_exports=None, engine=None, engine_version=None, final_snapshot_identifier=None, kms_key_id=None, master_password=None, master_username=None, port=None, preferred_backup_window=None, preferred_maintenance_window=None, skip_final_snapshot=None, snapshot_identifier=None, storage_encrypted=None, tags=None, vpc_security_group_ids=None, __props__=None, __name__=None, __opts__=None)¶

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, this provider 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.

import pulumi
import pulumi_aws as aws

docdb = aws.docdb.Cluster("docdb",
    backup_retention_period=5,
    cluster_identifier="my-docdb-cluster",
    engine="docdb",
    master_password="mustbeeightchars",
    master_username="foo",
    preferred_backup_window="07:00-09:00",
    skip_final_snapshot=True)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
apply_immediately (pulumi.Input[bool]) – Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.
availability_zones (pulumi.Input[list]) – A list of EC2 Availability Zones that instances in the DB cluster can be created in.
backup_retention_period (pulumi.Input[float]) – The days to retain backups for. Default 1
cluster_identifier (pulumi.Input[str]) – The cluster identifier. If omitted, this provider will assign a random, unique identifier.
cluster_identifier_prefix (pulumi.Input[str]) – Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifer.
cluster_members (pulumi.Input[list]) – List of DocDB Instances that are a part of this cluster
db_cluster_parameter_group_name (pulumi.Input[str]) – A cluster parameter group to associate with the cluster.
db_subnet_group_name (pulumi.Input[str]) – A DB subnet group to associate with this DB instance.
deletion_protection (pulumi.Input[bool]) – A value that indicates whether the DB cluster has deletion protection enabled. The database can’t be deleted when deletion protection is enabled. By default, deletion protection is disabled.
enabled_cloudwatch_logs_exports (pulumi.Input[list]) – List of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, profiler.
engine (pulumi.Input[str]) – The name of the database engine to be used for this DB cluster. Defaults to docdb. Valid Values: docdb
engine_version (pulumi.Input[str]) – The database engine version. Updating this argument results in an outage.
final_snapshot_identifier (pulumi.Input[str]) – The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
kms_key_id (pulumi.Input[str]) – The ARN for the KMS encryption key. When specifying kms_key_id, storage_encrypted needs to be set to true.
master_password (pulumi.Input[str]) – 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.
master_username (pulumi.Input[str]) – Username for the master DB user.
port (pulumi.Input[float]) – The port on which the DB accepts connections
preferred_backup_window (pulumi.Input[str]) – 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
skip_final_snapshot (pulumi.Input[bool]) – 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.
snapshot_identifier (pulumi.Input[str]) – 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.
storage_encrypted (pulumi.Input[bool]) – Specifies whether the DB cluster is encrypted. The default is false.
tags (pulumi.Input[dict]) – A map of tags to assign to the DB cluster.
vpc_security_group_ids (pulumi.Input[list]) – List of VPC security groups to associate with the Cluster

apply_immediately: pulumi.Output[bool] = None¶: Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.

arn: pulumi.Output[str] = None¶: Amazon Resource Name (ARN) of cluster

availability_zones: pulumi.Output[list] = None¶: A list of EC2 Availability Zones that instances in the DB cluster can be created in.

backup_retention_period: pulumi.Output[float] = None¶: The days to retain backups for. Default 1

cluster_identifier: pulumi.Output[str] = None¶: The cluster identifier. If omitted, this provider will assign a random, unique identifier.

cluster_identifier_prefix: pulumi.Output[str] = None¶: Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifer.

cluster_members: pulumi.Output[list] = None¶: List of DocDB Instances that are a part of this cluster

cluster_resource_id: pulumi.Output[str] = None¶: The DocDB Cluster Resource ID

db_cluster_parameter_group_name: pulumi.Output[str] = None¶: A cluster parameter group to associate with the cluster.

db_subnet_group_name: pulumi.Output[str] = None¶: A DB subnet group to associate with this DB instance.

deletion_protection: pulumi.Output[bool] = None¶: A value that indicates whether the DB cluster has deletion protection enabled. The database can’t be deleted when deletion protection is enabled. By default, deletion protection is disabled.

enabled_cloudwatch_logs_exports: pulumi.Output[list] = None¶: List of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, profiler.

endpoint: pulumi.Output[str] = None¶: The DNS address of the DocDB instance

engine: pulumi.Output[str] = None¶: The name of the database engine to be used for this DB cluster. Defaults to docdb. Valid Values: docdb

engine_version: pulumi.Output[str] = None¶: The database engine version. Updating this argument results in an outage.

final_snapshot_identifier: pulumi.Output[str] = None¶: The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.

hosted_zone_id: pulumi.Output[str] = None¶: The Route53 Hosted Zone ID of the endpoint

kms_key_id: pulumi.Output[str] = None¶: The ARN for the KMS encryption key. When specifying kms_key_id, storage_encrypted needs to be set to true.

master_password: pulumi.Output[str] = None¶: 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.

master_username: pulumi.Output[str] = None¶: Username for the master DB user.

port: pulumi.Output[float] = None¶: The port on which the DB accepts connections

preferred_backup_window: pulumi.Output[str] = None¶: 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

reader_endpoint: pulumi.Output[str] = None¶: A read-only endpoint for the DocDB cluster, automatically load-balanced across replicas

skip_final_snapshot: pulumi.Output[bool] = None¶: 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.

snapshot_identifier: pulumi.Output[str] = None¶: 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.

storage_encrypted: pulumi.Output[bool] = None¶: Specifies whether the DB cluster is encrypted. The default is false.

tags: pulumi.Output[dict] = None¶: A map of tags to assign to the DB cluster.

vpc_security_group_ids: pulumi.Output[list] = None¶: List of VPC security groups to associate with the Cluster

static get(resource_name, id, opts=None, apply_immediately=None, arn=None, availability_zones=None, backup_retention_period=None, cluster_identifier=None, cluster_identifier_prefix=None, cluster_members=None, cluster_resource_id=None, db_cluster_parameter_group_name=None, db_subnet_group_name=None, deletion_protection=None, enabled_cloudwatch_logs_exports=None, endpoint=None, engine=None, engine_version=None, final_snapshot_identifier=None, hosted_zone_id=None, kms_key_id=None, master_password=None, master_username=None, port=None, preferred_backup_window=None, preferred_maintenance_window=None, reader_endpoint=None, skip_final_snapshot=None, snapshot_identifier=None, storage_encrypted=None, tags=None, vpc_security_group_ids=None)¶

Get an existing Cluster resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
apply_immediately (pulumi.Input[bool]) – Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.
arn (pulumi.Input[str]) – Amazon Resource Name (ARN) of cluster
availability_zones (pulumi.Input[list]) – A list of EC2 Availability Zones that instances in the DB cluster can be created in.
backup_retention_period (pulumi.Input[float]) – The days to retain backups for. Default 1
cluster_identifier (pulumi.Input[str]) – The cluster identifier. If omitted, this provider will assign a random, unique identifier.
cluster_identifier_prefix (pulumi.Input[str]) – Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifer.
cluster_members (pulumi.Input[list]) – List of DocDB Instances that are a part of this cluster
cluster_resource_id (pulumi.Input[str]) – The DocDB Cluster Resource ID
db_cluster_parameter_group_name (pulumi.Input[str]) – A cluster parameter group to associate with the cluster.
db_subnet_group_name (pulumi.Input[str]) – A DB subnet group to associate with this DB instance.
deletion_protection (pulumi.Input[bool]) – A value that indicates whether the DB cluster has deletion protection enabled. The database can’t be deleted when deletion protection is enabled. By default, deletion protection is disabled.
enabled_cloudwatch_logs_exports (pulumi.Input[list]) – List of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, profiler.
endpoint (pulumi.Input[str]) – The DNS address of the DocDB instance
engine (pulumi.Input[str]) – The name of the database engine to be used for this DB cluster. Defaults to docdb. Valid Values: docdb
engine_version (pulumi.Input[str]) – The database engine version. Updating this argument results in an outage.
final_snapshot_identifier (pulumi.Input[str]) – The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
hosted_zone_id (pulumi.Input[str]) – The Route53 Hosted Zone ID of the endpoint
kms_key_id (pulumi.Input[str]) – The ARN for the KMS encryption key. When specifying kms_key_id, storage_encrypted needs to be set to true.
master_password (pulumi.Input[str]) – 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.
master_username (pulumi.Input[str]) – Username for the master DB user.
port (pulumi.Input[float]) – The port on which the DB accepts connections
preferred_backup_window (pulumi.Input[str]) – 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
reader_endpoint (pulumi.Input[str]) – A read-only endpoint for the DocDB cluster, automatically load-balanced across replicas
skip_final_snapshot (pulumi.Input[bool]) – 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.
snapshot_identifier (pulumi.Input[str]) – 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.
storage_encrypted (pulumi.Input[bool]) – Specifies whether the DB cluster is encrypted. The default is false.
tags (pulumi.Input[dict]) – A map of tags to assign to the DB cluster.
vpc_security_group_ids (pulumi.Input[list]) – List of VPC security groups to associate with the Cluster

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.docdb.ClusterInstance(resource_name, opts=None, apply_immediately=None, auto_minor_version_upgrade=None, availability_zone=None, ca_cert_identifier=None, cluster_identifier=None, engine=None, identifier=None, identifier_prefix=None, instance_class=None, preferred_maintenance_window=None, promotion_tier=None, tags=None, __props__=None, __name__=None, __opts__=None)¶

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

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 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.

import pulumi
import pulumi_aws as aws

default = aws.docdb.Cluster("default",
    availability_zones=[
        "us-west-2a",
        "us-west-2b",
        "us-west-2c",
    ],
    cluster_identifier="docdb-cluster-demo",
    master_password="barbut8chars",
    master_username="foo")
cluster_instances = []
for range in [{"value": i} for i in range(0, 2)]:
    cluster_instances.append(aws.docdb.ClusterInstance(f"clusterInstances-{range['value']}",
        cluster_identifier=default.id,
        identifier=f"docdb-cluster-demo-{range['value']}",
        instance_class="db.r5.large"))

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
apply_immediately (pulumi.Input[bool]) – Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default isfalse.
auto_minor_version_upgrade (pulumi.Input[bool]) – Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Default true.
availability_zone (pulumi.Input[str]) – The EC2 Availability Zone that the DB instance is created in. See docs about the details.
ca_cert_identifier (pulumi.Input[str]) – (Optional) The identifier of the CA certificate for the DB instance.
cluster_identifier (pulumi.Input[str]) – The identifier of the docdb.Cluster in which to launch this instance.
engine (pulumi.Input[str]) – The name of the database engine to be used for the DocDB instance. Defaults to docdb. Valid Values: docdb.
identifier (pulumi.Input[str]) – The indentifier for the DocDB instance, if omitted, this provider will assign a random, unique identifier.
identifier_prefix (pulumi.Input[str]) – Creates a unique identifier beginning with the specified prefix. Conflicts with identifer.
instance_class (pulumi.Input[str]) – The instance class to use. For details on CPU and memory, see Scaling for DocDB Instances. DocDB currently supports the below instance classes. Please see AWS Documentation for complete details.

- db.r4.large
- db.r4.xlarge
- db.r4.2xlarge
- db.r4.4xlarge
- db.r4.8xlarge
- db.r4.16xlarge

Parameters

preferred_maintenance_window (pulumi.Input[str]) – The window to perform maintenance in. Syntax: “ddd:hh24:mi-ddd:hh24:mi”. Eg: “Mon:00:00-Mon:03:00”.
promotion_tier (pulumi.Input[float]) – Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoter to writer.
tags (pulumi.Input[dict]) – A map of tags to assign to the instance.

apply_immediately: pulumi.Output[bool] = None¶: Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default isfalse.

arn: pulumi.Output[str] = None¶: Amazon Resource Name (ARN) of cluster instance

auto_minor_version_upgrade: pulumi.Output[bool] = None¶: Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Default true.

availability_zone: pulumi.Output[str] = None¶: The EC2 Availability Zone that the DB instance is created in. See docs about the details.

ca_cert_identifier: pulumi.Output[str] = None¶: (Optional) The identifier of the CA certificate for the DB instance.

cluster_identifier: pulumi.Output[str] = None¶: The identifier of the docdb.Cluster in which to launch this instance.

db_subnet_group_name: pulumi.Output[str] = None¶: The DB subnet group to associate with this DB instance.

dbi_resource_id: pulumi.Output[str] = None¶: The region-unique, immutable identifier for the DB instance.

endpoint: pulumi.Output[str] = None¶: The DNS address for this instance. May not be writable

engine: pulumi.Output[str] = None¶: The name of the database engine to be used for the DocDB instance. Defaults to docdb. Valid Values: docdb.

engine_version: pulumi.Output[str] = None¶: The database engine version

identifier: pulumi.Output[str] = None¶: The indentifier for the DocDB instance, if omitted, this provider will assign a random, unique identifier.

identifier_prefix: pulumi.Output[str] = None¶: Creates a unique identifier beginning with the specified prefix. Conflicts with identifer.

instance_class: pulumi.Output[str] = None¶

The instance class to use. For details on CPU and memory, see Scaling for DocDB Instances. DocDB currently supports the below instance classes. Please see AWS Documentation for complete details.

db.r4.large
db.r4.xlarge
db.r4.2xlarge
db.r4.4xlarge
db.r4.8xlarge
db.r4.16xlarge

kms_key_id: pulumi.Output[str] = None¶: The ARN for the KMS encryption key if one is set to the cluster.

port: pulumi.Output[float] = None¶: The database port

preferred_backup_window: pulumi.Output[str] = None¶: The daily time range during which automated backups are created if automated backups are enabled.

preferred_maintenance_window: pulumi.Output[str] = None¶: The window to perform maintenance in. Syntax: “ddd:hh24:mi-ddd:hh24:mi”. Eg: “Mon:00:00-Mon:03:00”.

promotion_tier: pulumi.Output[float] = None¶: Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoter to writer.

storage_encrypted: pulumi.Output[bool] = None¶: Specifies whether the DB cluster is encrypted.

tags: pulumi.Output[dict] = None¶: A map of tags to assign to the instance.

writer: pulumi.Output[bool] = None¶: Boolean indicating if this instance is writable. False indicates this instance is a read replica.

static get(resource_name, id, opts=None, apply_immediately=None, arn=None, auto_minor_version_upgrade=None, availability_zone=None, ca_cert_identifier=None, cluster_identifier=None, db_subnet_group_name=None, dbi_resource_id=None, endpoint=None, engine=None, engine_version=None, identifier=None, identifier_prefix=None, instance_class=None, kms_key_id=None, port=None, preferred_backup_window=None, preferred_maintenance_window=None, promotion_tier=None, publicly_accessible=None, storage_encrypted=None, tags=None, writer=None)¶

Get an existing ClusterInstance resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
apply_immediately (pulumi.Input[bool]) – Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default isfalse.
arn (pulumi.Input[str]) – Amazon Resource Name (ARN) of cluster instance
auto_minor_version_upgrade (pulumi.Input[bool]) – Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Default true.
availability_zone (pulumi.Input[str]) –
The EC2 Availability Zone that the DB instance is created in. See docs about the details.
ca_cert_identifier (pulumi.Input[str]) – (Optional) The identifier of the CA certificate for the DB instance.
cluster_identifier (pulumi.Input[str]) – The identifier of the docdb.Cluster in which to launch this instance.
db_subnet_group_name (pulumi.Input[str]) – The DB subnet group to associate with this DB instance.
dbi_resource_id (pulumi.Input[str]) – The region-unique, immutable identifier for the DB instance.
endpoint (pulumi.Input[str]) – The DNS address for this instance. May not be writable
engine (pulumi.Input[str]) – The name of the database engine to be used for the DocDB instance. Defaults to docdb. Valid Values: docdb.
engine_version (pulumi.Input[str]) – The database engine version
identifier (pulumi.Input[str]) – The indentifier for the DocDB instance, if omitted, this provider will assign a random, unique identifier.
identifier_prefix (pulumi.Input[str]) – Creates a unique identifier beginning with the specified prefix. Conflicts with identifer.
instance_class (pulumi.Input[str]) –
The instance class to use. For details on CPU and memory, see Scaling for DocDB Instances. DocDB currently supports the below instance classes. Please see AWS Documentation for complete details.

- db.r4.large
- db.r4.xlarge
- db.r4.2xlarge
- db.r4.4xlarge
- db.r4.8xlarge
- db.r4.16xlarge

Parameters

kms_key_id (pulumi.Input[str]) – The ARN for the KMS encryption key if one is set to the cluster.
port (pulumi.Input[float]) – The database port
preferred_backup_window (pulumi.Input[str]) – The daily time range during which automated backups are created if automated backups are enabled.
preferred_maintenance_window (pulumi.Input[str]) – The window to perform maintenance in. Syntax: “ddd:hh24:mi-ddd:hh24:mi”. Eg: “Mon:00:00-Mon:03:00”.
promotion_tier (pulumi.Input[float]) – Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoter to writer.
storage_encrypted (pulumi.Input[bool]) – Specifies whether the DB cluster is encrypted.
tags (pulumi.Input[dict]) – A map of tags to assign to the instance.
writer (pulumi.Input[bool]) – Boolean indicating if this instance is writable. False indicates this instance is a read replica.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.docdb.ClusterParameterGroup(resource_name, opts=None, description=None, family=None, name=None, name_prefix=None, parameters=None, tags=None, __props__=None, __name__=None, __opts__=None)¶

Manages a DocumentDB Cluster Parameter Group

import pulumi
import pulumi_aws as aws

example = aws.docdb.ClusterParameterGroup("example",
    description="docdb cluster parameter group",
    family="docdb3.6",
    parameters=[{
        "name": "tls",
        "value": "enabled",
    }])

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
description (pulumi.Input[str]) – The description of the documentDB cluster parameter group. Defaults to “Managed by Pulumi”.
family (pulumi.Input[str]) – The family of the documentDB cluster parameter group.
name (pulumi.Input[str]) – The name of the documentDB parameter.
name_prefix (pulumi.Input[str]) – Creates a unique name beginning with the specified prefix. Conflicts with name.
parameters (pulumi.Input[list]) – A list of documentDB parameters to apply.
tags (pulumi.Input[dict]) – A map of tags to assign to the resource.

The parameters object supports the following:

applyMethod (pulumi.Input[str]) - Valid values are immediate and pending-reboot. Defaults to pending-reboot.
name (pulumi.Input[str]) - The name of the documentDB parameter.
value (pulumi.Input[str]) - The value of the documentDB parameter.

arn: pulumi.Output[str] = None¶: The ARN of the documentDB cluster parameter group.

description: pulumi.Output[str] = None¶: The description of the documentDB cluster parameter group. Defaults to “Managed by Pulumi”.

family: pulumi.Output[str] = None¶: The family of the documentDB cluster parameter group.

name: pulumi.Output[str] = None¶: The name of the documentDB parameter.

name_prefix: pulumi.Output[str] = None¶: Creates a unique name beginning with the specified prefix. Conflicts with name.

parameters: pulumi.Output[list] = None¶

A list of documentDB parameters to apply.

applyMethod (str) - Valid values are immediate and pending-reboot. Defaults to pending-reboot.
name (str) - The name of the documentDB parameter.
value (str) - The value of the documentDB parameter.

tags: pulumi.Output[dict] = None¶: A map of tags to assign to the resource.

static get(resource_name, id, opts=None, arn=None, description=None, family=None, name=None, name_prefix=None, parameters=None, tags=None)¶

Get an existing ClusterParameterGroup resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
arn (pulumi.Input[str]) – The ARN of the documentDB cluster parameter group.
description (pulumi.Input[str]) – The description of the documentDB cluster parameter group. Defaults to “Managed by Pulumi”.
family (pulumi.Input[str]) – The family of the documentDB cluster parameter group.
name (pulumi.Input[str]) – The name of the documentDB parameter.
name_prefix (pulumi.Input[str]) – Creates a unique name beginning with the specified prefix. Conflicts with name.
parameters (pulumi.Input[list]) – A list of documentDB parameters to apply.
tags (pulumi.Input[dict]) – A map of tags to assign to the resource.

The parameters object supports the following:

applyMethod (pulumi.Input[str]) - Valid values are immediate and pending-reboot. Defaults to pending-reboot.
name (pulumi.Input[str]) - The name of the documentDB parameter.
value (pulumi.Input[str]) - The value of the documentDB parameter.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.docdb.ClusterSnapshot(resource_name, opts=None, db_cluster_identifier=None, db_cluster_snapshot_identifier=None, __props__=None, __name__=None, __opts__=None)¶

Manages a DocDB database cluster snapshot for DocDB clusters.

import pulumi
import pulumi_aws as aws

example = aws.docdb.ClusterSnapshot("example",
    db_cluster_identifier=aws_docdb_cluster["example"]["id"],
    db_cluster_snapshot_identifier="resourcetestsnapshot1234")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
db_cluster_identifier (pulumi.Input[str]) – The DocDB Cluster Identifier from which to take the snapshot.
db_cluster_snapshot_identifier (pulumi.Input[str]) – The Identifier for the snapshot.

availability_zones: pulumi.Output[list] = None¶: List of EC2 Availability Zones that instances in the DocDB cluster snapshot can be restored in.

db_cluster_identifier: pulumi.Output[str] = None¶: The DocDB Cluster Identifier from which to take the snapshot.

db_cluster_snapshot_arn: pulumi.Output[str] = None¶: The Amazon Resource Name (ARN) for the DocDB Cluster Snapshot.

db_cluster_snapshot_identifier: pulumi.Output[str] = None¶: The Identifier for the snapshot.

engine: pulumi.Output[str] = None¶: Specifies the name of the database engine.

engine_version: pulumi.Output[str] = None¶: Version of the database engine for this DocDB cluster snapshot.

kms_key_id: pulumi.Output[str] = None¶: If storage_encrypted is true, the AWS KMS key identifier for the encrypted DocDB cluster snapshot.

port: pulumi.Output[float] = None¶: Port that the DocDB cluster was listening on at the time of the snapshot.

status: pulumi.Output[str] = None¶: The status of this DocDB Cluster Snapshot.

storage_encrypted: pulumi.Output[bool] = None¶: Specifies whether the DocDB cluster snapshot is encrypted.

vpc_id: pulumi.Output[str] = None¶: The VPC ID associated with the DocDB cluster snapshot.

static get(resource_name, id, opts=None, availability_zones=None, db_cluster_identifier=None, db_cluster_snapshot_arn=None, db_cluster_snapshot_identifier=None, engine=None, engine_version=None, kms_key_id=None, port=None, snapshot_type=None, source_db_cluster_snapshot_arn=None, status=None, storage_encrypted=None, vpc_id=None)¶

Get an existing ClusterSnapshot resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
availability_zones (pulumi.Input[list]) – List of EC2 Availability Zones that instances in the DocDB cluster snapshot can be restored in.
db_cluster_identifier (pulumi.Input[str]) – The DocDB Cluster Identifier from which to take the snapshot.
db_cluster_snapshot_arn (pulumi.Input[str]) – The Amazon Resource Name (ARN) for the DocDB Cluster Snapshot.
db_cluster_snapshot_identifier (pulumi.Input[str]) – The Identifier for the snapshot.
engine (pulumi.Input[str]) – Specifies the name of the database engine.
engine_version (pulumi.Input[str]) – Version of the database engine for this DocDB cluster snapshot.
kms_key_id (pulumi.Input[str]) – If storage_encrypted is true, the AWS KMS key identifier for the encrypted DocDB cluster snapshot.
port (pulumi.Input[float]) – Port that the DocDB cluster was listening on at the time of the snapshot.
status (pulumi.Input[str]) – The status of this DocDB Cluster Snapshot.
storage_encrypted (pulumi.Input[bool]) – Specifies whether the DocDB cluster snapshot is encrypted.
vpc_id (pulumi.Input[str]) – The VPC ID associated with the DocDB cluster snapshot.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.docdb.SubnetGroup(resource_name, opts=None, description=None, name=None, name_prefix=None, subnet_ids=None, tags=None, __props__=None, __name__=None, __opts__=None)¶

Provides an DocumentDB subnet group resource.

import pulumi
import pulumi_aws as aws

default = aws.docdb.SubnetGroup("default",
    subnet_ids=[
        aws_subnet["frontend"]["id"],
        aws_subnet["backend"]["id"],
    ],
    tags={
        "Name": "My docdb subnet group",
    })

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
description (pulumi.Input[str]) – The description of the docDB subnet group. Defaults to “Managed by Pulumi”.
name (pulumi.Input[str]) – The name of the docDB subnet group. If omitted, this provider will assign a random, unique name.
name_prefix (pulumi.Input[str]) – Creates a unique name beginning with the specified prefix. Conflicts with name.
subnet_ids (pulumi.Input[list]) – A list of VPC subnet IDs.
tags (pulumi.Input[dict]) – A map of tags to assign to the resource.

arn: pulumi.Output[str] = None¶: The ARN of the docDB subnet group.

description: pulumi.Output[str] = None¶: The description of the docDB subnet group. Defaults to “Managed by Pulumi”.

name: pulumi.Output[str] = None¶: The name of the docDB subnet group. If omitted, this provider will assign a random, unique name.

name_prefix: pulumi.Output[str] = None¶: Creates a unique name beginning with the specified prefix. Conflicts with name.

subnet_ids: pulumi.Output[list] = None¶: A list of VPC subnet IDs.

tags: pulumi.Output[dict] = None¶: A map of tags to assign to the resource.

static get(resource_name, id, opts=None, arn=None, description=None, name=None, name_prefix=None, subnet_ids=None, tags=None)¶

Get an existing SubnetGroup resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
arn (pulumi.Input[str]) – The ARN of the docDB subnet group.
description (pulumi.Input[str]) – The description of the docDB subnet group. Defaults to “Managed by Pulumi”.
name (pulumi.Input[str]) – The name of the docDB subnet group. If omitted, this provider will assign a random, unique name.
name_prefix (pulumi.Input[str]) – Creates a unique name beginning with the specified prefix. Conflicts with name.
subnet_ids (pulumi.Input[list]) – A list of VPC subnet IDs.
tags (pulumi.Input[dict]) – A map of tags to assign to the resource.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

docdb¶

On This Page