pulumi-aws-kotlin/com.pulumi.aws.docdb.kotlin

Package-level declarations

Types

class Cluster : KotlinCustomResource

Manages a DocumentDB Cluster. Changes to a DocumentDB 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).

ClusterArgs

data class ClusterArgs(val allowMajorVersionUpgrade: Output<Boolean>? = null, val applyImmediately: Output<Boolean>? = null, val availabilityZones: Output<List<String>>? = null, val backupRetentionPeriod: Output<Int>? = null, val clusterIdentifier: Output<String>? = null, val clusterIdentifierPrefix: Output<String>? = null, val clusterMembers: Output<List<String>>? = null, val dbClusterParameterGroupName: Output<String>? = null, val dbSubnetGroupName: Output<String>? = null, val deletionProtection: Output<Boolean>? = null, val enabledCloudwatchLogsExports: Output<List<String>>? = null, val engine: Output<String>? = null, val engineVersion: Output<String>? = null, val finalSnapshotIdentifier: Output<String>? = null, val globalClusterIdentifier: Output<String>? = null, val kmsKeyId: Output<String>? = null, val manageMasterUserPassword: Output<Boolean>? = null, val masterPassword: Output<String>? = null, val masterUsername: Output<String>? = null, val port: Output<Int>? = null, val preferredBackupWindow: Output<String>? = null, val preferredMaintenanceWindow: Output<String>? = null, val restoreToPointInTime: Output<ClusterRestoreToPointInTimeArgs>? = null, val skipFinalSnapshot: Output<Boolean>? = null, val snapshotIdentifier: Output<String>? = null, val storageEncrypted: Output<Boolean>? = null, val storageType: Output<String>? = null, val tags: Output<Map<String, String>>? = null, val vpcSecurityGroupIds: Output<List<String>>? = null) : ConvertibleToJava<ClusterArgs>

ClusterArgsBuilder

class ClusterArgsBuilder

Builder for ClusterArgs.

ClusterInstance

class ClusterInstance : KotlinCustomResource

Provides an DocumentDB Cluster Resource Instance. A Cluster Instance Resource defines attributes that are specific to a single instance in a 1. You do not designate a primary and subsequent replicas. Instead, you simply add DocumentDB Instances and DocumentDB manages the replication. You can use the 3 meta-parameter to make multiple instances and join them all to the same DocumentDB Cluster, or you may specify different Cluster Instance resources with various instance_class sizes.

ClusterInstanceArgs

data class ClusterInstanceArgs(val applyImmediately: Output<Boolean>? = null, val autoMinorVersionUpgrade: Output<Boolean>? = null, val availabilityZone: Output<String>? = null, val caCertIdentifier: Output<String>? = null, val clusterIdentifier: Output<String>? = null, val copyTagsToSnapshot: Output<Boolean>? = null, val enablePerformanceInsights: Output<Boolean>? = null, val engine: Output<String>? = null, val identifier: Output<String>? = null, val identifierPrefix: Output<String>? = null, val instanceClass: Output<String>? = null, val performanceInsightsKmsKeyId: Output<String>? = null, val preferredMaintenanceWindow: Output<String>? = null, val promotionTier: Output<Int>? = null, val tags: Output<Map<String, String>>? = null) : ConvertibleToJava<ClusterInstanceArgs>

ClusterInstanceArgsBuilder

class ClusterInstanceArgsBuilder

Builder for ClusterInstanceArgs.

ClusterInstanceMapper

object ClusterInstanceMapper : ResourceMapper<ClusterInstance>

ClusterInstanceResourceBuilder

class ClusterInstanceResourceBuilder

Builder for ClusterInstance.

ClusterMapper

object ClusterMapper : ResourceMapper<Cluster>

ClusterParameterGroup

class ClusterParameterGroup : KotlinCustomResource

Manages a DocumentDB Cluster Parameter Group

ClusterParameterGroupArgs

data class ClusterParameterGroupArgs(val description: Output<String>? = null, val family: Output<String>? = null, val name: Output<String>? = null, val namePrefix: Output<String>? = null, val parameters: Output<List<ClusterParameterGroupParameterArgs>>? = null, val tags: Output<Map<String, String>>? = null) : ConvertibleToJava<ClusterParameterGroupArgs>

Manages a DocumentDB Cluster Parameter Group

ClusterParameterGroupArgsBuilder

class ClusterParameterGroupArgsBuilder

Builder for ClusterParameterGroupArgs.

ClusterParameterGroupMapper

object ClusterParameterGroupMapper : ResourceMapper<ClusterParameterGroup>

ClusterParameterGroupResourceBuilder

class ClusterParameterGroupResourceBuilder

Builder for ClusterParameterGroup.

ClusterResourceBuilder

class ClusterResourceBuilder

Builder for Cluster.

ClusterSnapshot

class ClusterSnapshot : KotlinCustomResource

Manages a DocumentDB database cluster snapshot for DocumentDB clusters.

ClusterSnapshotArgs

data class ClusterSnapshotArgs(val dbClusterIdentifier: Output<String>? = null, val dbClusterSnapshotIdentifier: Output<String>? = null) : ConvertibleToJava<ClusterSnapshotArgs>

Manages a DocumentDB database cluster snapshot for DocumentDB clusters.

ClusterSnapshotArgsBuilder

class ClusterSnapshotArgsBuilder

Builder for ClusterSnapshotArgs.

ClusterSnapshotMapper

object ClusterSnapshotMapper : ResourceMapper<ClusterSnapshot>

ClusterSnapshotResourceBuilder

class ClusterSnapshotResourceBuilder

Builder for ClusterSnapshot.

DocdbFunctions

object DocdbFunctions

ElasticCluster

class ElasticCluster : KotlinCustomResource

Manages an AWS DocDB (DocumentDB) Elastic Cluster.

ElasticClusterArgs

data class ElasticClusterArgs(val adminUserName: Output<String>? = null, val adminUserPassword: Output<String>? = null, val authType: Output<String>? = null, val backupRetentionPeriod: Output<Int>? = null, val kmsKeyId: Output<String>? = null, val name: Output<String>? = null, val preferredBackupWindow: Output<String>? = null, val preferredMaintenanceWindow: Output<String>? = null, val shardCapacity: Output<Int>? = null, val shardCount: Output<Int>? = null, val subnetIds: Output<List<String>>? = null, val tags: Output<Map<String, String>>? = null, val timeouts: Output<ElasticClusterTimeoutsArgs>? = null, val vpcSecurityGroupIds: Output<List<String>>? = null) : ConvertibleToJava<ElasticClusterArgs>

Manages an AWS DocDB (DocumentDB) Elastic Cluster.

ElasticClusterArgsBuilder

class ElasticClusterArgsBuilder

Builder for ElasticClusterArgs.

ElasticClusterMapper

object ElasticClusterMapper : ResourceMapper<ElasticCluster>

ElasticClusterResourceBuilder

class ElasticClusterResourceBuilder

Builder for ElasticCluster.

EventSubscription

class EventSubscription : KotlinCustomResource

Provides a DocumentDB event subscription resource.

EventSubscriptionArgs

data class EventSubscriptionArgs(val enabled: Output<Boolean>? = null, val eventCategories: Output<List<String>>? = null, val name: Output<String>? = null, val namePrefix: Output<String>? = null, val snsTopicArn: Output<String>? = null, val sourceIds: Output<List<String>>? = null, val sourceType: Output<String>? = null, val tags: Output<Map<String, String>>? = null) : ConvertibleToJava<EventSubscriptionArgs>

Provides a DocumentDB event subscription resource.

EventSubscriptionArgsBuilder

class EventSubscriptionArgsBuilder

Builder for EventSubscriptionArgs.

EventSubscriptionMapper

object EventSubscriptionMapper : ResourceMapper<EventSubscription>

EventSubscriptionResourceBuilder

class EventSubscriptionResourceBuilder

Builder for EventSubscription.

GlobalCluster

class GlobalCluster : KotlinCustomResource

Manages an DocumentDB Global Cluster. A global cluster consists of one primary region and up to five read-only secondary regions. You issue write operations directly to the primary cluster in the primary region and Amazon DocumentDB automatically replicates the data to the secondary regions using dedicated infrastructure. More information about DocumentDB Global Clusters can be found in the DocumentDB Developer Guide.

GlobalClusterArgs

data class GlobalClusterArgs(val databaseName: Output<String>? = null, val deletionProtection: Output<Boolean>? = null, val engine: Output<String>? = null, val engineVersion: Output<String>? = null, val globalClusterIdentifier: Output<String>? = null, val sourceDbClusterIdentifier: Output<String>? = null, val storageEncrypted: Output<Boolean>? = null) : ConvertibleToJava<GlobalClusterArgs>

GlobalClusterArgsBuilder

class GlobalClusterArgsBuilder

Builder for GlobalClusterArgs.

GlobalClusterMapper

object GlobalClusterMapper : ResourceMapper<GlobalCluster>

GlobalClusterResourceBuilder

class GlobalClusterResourceBuilder

Builder for GlobalCluster.

SubnetGroup

class SubnetGroup : KotlinCustomResource

Provides an DocumentDB subnet group resource.

SubnetGroupArgs

data class SubnetGroupArgs(val description: Output<String>? = null, val name: Output<String>? = null, val namePrefix: Output<String>? = null, val subnetIds: Output<List<String>>? = null, val tags: Output<Map<String, String>>? = null) : ConvertibleToJava<SubnetGroupArgs>

Provides an DocumentDB subnet group resource.

SubnetGroupArgsBuilder

class SubnetGroupArgsBuilder

Builder for SubnetGroupArgs.

SubnetGroupMapper

object SubnetGroupMapper : ResourceMapper<SubnetGroup>

SubnetGroupResourceBuilder

class SubnetGroupResourceBuilder

Builder for SubnetGroup.