Package-level declarations

Types

Link copied to clipboard
class Cluster : KotlinCustomResource

Provides an Neptune Cluster Resource. A Cluster Resource defines attributes that are applied to the entire cluster of Neptune Cluster Instances. Changes to a Neptune Cluster can occur when you manually change a parameter, such as backup_retention_period, 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).

Link copied to clipboard
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 copyTagsToSnapshot: Output<Boolean>? = null, val deletionProtection: Output<Boolean>? = null, val enableCloudwatchLogsExports: 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 iamDatabaseAuthenticationEnabled: Output<Boolean>? = null, val iamRoles: Output<List<String>>? = null, val kmsKeyArn: Output<String>? = null, val neptuneClusterParameterGroupName: Output<String>? = null, val neptuneInstanceParameterGroupName: Output<String>? = null, val neptuneSubnetGroupName: Output<String>? = null, val port: Output<Int>? = null, val preferredBackupWindow: Output<String>? = null, val preferredMaintenanceWindow: Output<String>? = null, val replicationSourceIdentifier: Output<String>? = null, val serverlessV2ScalingConfiguration: Output<ClusterServerlessV2ScalingConfigurationArgs>? = null, val skipFinalSnapshot: Output<Boolean>? = null, val snapshotIdentifier: Output<String>? = null, val storageEncrypted: Output<Boolean>? = null, val tags: Output<Map<String, String>>? = null, val vpcSecurityGroupIds: Output<List<String>>? = null) : ConvertibleToJava<ClusterArgs>

Provides an Neptune Cluster Resource. A Cluster Resource defines attributes that are applied to the entire cluster of Neptune Cluster Instances. Changes to a Neptune Cluster can occur when you manually change a parameter, such as backup_retention_period, 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).

Link copied to clipboard
Link copied to clipboard
class ClusterEndpoint : KotlinCustomResource

Provides an Neptune Cluster Endpoint Resource.

Link copied to clipboard
data class ClusterEndpointArgs(val clusterEndpointIdentifier: Output<String>? = null, val clusterIdentifier: Output<String>? = null, val endpointType: Output<String>? = null, val excludedMembers: Output<List<String>>? = null, val staticMembers: Output<List<String>>? = null, val tags: Output<Map<String, String>>? = null) : ConvertibleToJava<ClusterEndpointArgs>

Provides an Neptune Cluster Endpoint Resource.

Link copied to clipboard
object ClusterEndpointMapper : ResourceMapper<ClusterEndpoint>
Link copied to clipboard
class ClusterInstance : KotlinCustomResource

A Cluster Instance Resource defines attributes that are specific to a single instance in a Neptune Cluster. You can simply add neptune instances and Neptune manages the replication. You can use the count meta-parameter to make multiple instances and join them all to the same Neptune Cluster, or you may specify different Cluster Instance resources with various instance_class sizes.

Link copied to clipboard
data class ClusterInstanceArgs(val applyImmediately: Output<Boolean>? = null, val autoMinorVersionUpgrade: Output<Boolean>? = null, val availabilityZone: Output<String>? = null, val clusterIdentifier: Output<String>? = null, val engine: Output<String>? = null, val engineVersion: Output<String>? = null, val identifier: Output<String>? = null, val identifierPrefix: Output<String>? = null, val instanceClass: Output<String>? = null, val neptuneParameterGroupName: Output<String>? = null, val neptuneSubnetGroupName: Output<String>? = null, val port: Output<Int>? = null, val preferredBackupWindow: Output<String>? = null, val preferredMaintenanceWindow: Output<String>? = null, val promotionTier: Output<Int>? = null, val publiclyAccessible: Output<Boolean>? = null, val tags: Output<Map<String, String>>? = null) : ConvertibleToJava<ClusterInstanceArgs>

A Cluster Instance Resource defines attributes that are specific to a single instance in a Neptune Cluster. You can simply add neptune instances and Neptune manages the replication. You can use the count meta-parameter to make multiple instances and join them all to the same Neptune Cluster, or you may specify different Cluster Instance resources with various instance_class sizes.

Link copied to clipboard
object ClusterInstanceMapper : ResourceMapper<ClusterInstance>
Link copied to clipboard
object ClusterMapper : ResourceMapper<Cluster>
Link copied to clipboard
class ClusterParameterGroup : KotlinCustomResource

Manages a Neptune Cluster Parameter Group

Link copied to clipboard
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 Neptune Cluster Parameter Group

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class ClusterSnapshot : KotlinCustomResource

Manages a Neptune database cluster snapshot.

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

Manages a Neptune database cluster snapshot.

Link copied to clipboard
object ClusterSnapshotMapper : ResourceMapper<ClusterSnapshot>
Link copied to clipboard
class EventSubscription : KotlinCustomResource

aws_neptune_event_subscription can be imported by using the event subscription name, e.g.,

Link copied to clipboard
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>

aws_neptune_event_subscription can be imported by using the event subscription name, e.g.,

Link copied to clipboard
object EventSubscriptionMapper : ResourceMapper<EventSubscription>
Link copied to clipboard
class GlobalCluster : KotlinCustomResource

Manages a Neptune 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 Neptune automatically replicates the data to the secondary regions using dedicated infrastructure. More information about Neptune Global Clusters can be found in the Neptune User Guide.

Link copied to clipboard
data class GlobalClusterArgs(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>

Manages a Neptune 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 Neptune automatically replicates the data to the secondary regions using dedicated infrastructure. More information about Neptune Global Clusters can be found in the Neptune User Guide.

Link copied to clipboard
Link copied to clipboard
object GlobalClusterMapper : ResourceMapper<GlobalCluster>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class ParameterGroup : KotlinCustomResource

Manages a Neptune Parameter Group

Link copied to clipboard
data class ParameterGroupArgs(val description: Output<String>? = null, val family: Output<String>? = null, val name: Output<String>? = null, val parameters: Output<List<ParameterGroupParameterArgs>>? = null, val tags: Output<Map<String, String>>? = null) : ConvertibleToJava<ParameterGroupArgs>

Manages a Neptune Parameter Group

Link copied to clipboard
Link copied to clipboard
object ParameterGroupMapper : ResourceMapper<ParameterGroup>
Link copied to clipboard
class SubnetGroup : KotlinCustomResource

Provides an Neptune subnet group resource.

Link copied to clipboard
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 Neptune subnet group resource.

Link copied to clipboard
Link copied to clipboard
object SubnetGroupMapper : ResourceMapper<SubnetGroup>
Link copied to clipboard

Functions

Link copied to clipboard
fun cluster(name: String): Cluster
suspend fun cluster(name: String, block: suspend ClusterResourceBuilder.() -> Unit): Cluster
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
suspend fun subnetGroup(name: String, block: suspend SubnetGroupResourceBuilder.() -> Unit): SubnetGroup