Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.pulumi.aws.neptune.kotlin.EventSubscription.kt Maven / Gradle / Ivy
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.aws.neptune.kotlin
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.Deprecated
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.collections.Map
/**
* Builder for [EventSubscription].
*/
@PulumiTagMarker
public class EventSubscriptionResourceBuilder internal constructor() {
public var name: String? = null
public var args: EventSubscriptionArgs = EventSubscriptionArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend EventSubscriptionArgsBuilder.() -> Unit) {
val builder = EventSubscriptionArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): EventSubscription {
val builtJavaResource = com.pulumi.aws.neptune.EventSubscription(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return EventSubscription(builtJavaResource)
}
}
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
* const _default = new aws.neptune.Cluster("default", {
* clusterIdentifier: "neptune-cluster-demo",
* engine: "neptune",
* backupRetentionPeriod: 5,
* preferredBackupWindow: "07:00-09:00",
* skipFinalSnapshot: true,
* iamDatabaseAuthenticationEnabled: true,
* applyImmediately: true,
* });
* const example = new aws.neptune.ClusterInstance("example", {
* clusterIdentifier: _default.id,
* engine: "neptune",
* instanceClass: "db.r4.large",
* applyImmediately: true,
* });
* const defaultTopic = new aws.sns.Topic("default", {name: "neptune-events"});
* const defaultEventSubscription = new aws.neptune.EventSubscription("default", {
* name: "neptune-event-sub",
* snsTopicArn: defaultTopic.arn,
* sourceType: "db-instance",
* sourceIds: [example.id],
* eventCategories: [
* "maintenance",
* "availability",
* "creation",
* "backup",
* "restoration",
* "recovery",
* "deletion",
* "failover",
* "failure",
* "notification",
* "configuration change",
* "read replica",
* ],
* tags: {
* env: "test",
* },
* });
* ```
* ```python
* import pulumi
* import pulumi_aws as aws
* default = aws.neptune.Cluster("default",
* cluster_identifier="neptune-cluster-demo",
* engine="neptune",
* backup_retention_period=5,
* preferred_backup_window="07:00-09:00",
* skip_final_snapshot=True,
* iam_database_authentication_enabled=True,
* apply_immediately=True)
* example = aws.neptune.ClusterInstance("example",
* cluster_identifier=default.id,
* engine="neptune",
* instance_class="db.r4.large",
* apply_immediately=True)
* default_topic = aws.sns.Topic("default", name="neptune-events")
* default_event_subscription = aws.neptune.EventSubscription("default",
* name="neptune-event-sub",
* sns_topic_arn=default_topic.arn,
* source_type="db-instance",
* source_ids=[example.id],
* event_categories=[
* "maintenance",
* "availability",
* "creation",
* "backup",
* "restoration",
* "recovery",
* "deletion",
* "failover",
* "failure",
* "notification",
* "configuration change",
* "read replica",
* ],
* tags={
* "env": "test",
* })
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Aws = Pulumi.Aws;
* return await Deployment.RunAsync(() =>
* {
* var @default = new Aws.Neptune.Cluster("default", new()
* {
* ClusterIdentifier = "neptune-cluster-demo",
* Engine = "neptune",
* BackupRetentionPeriod = 5,
* PreferredBackupWindow = "07:00-09:00",
* SkipFinalSnapshot = true,
* IamDatabaseAuthenticationEnabled = true,
* ApplyImmediately = true,
* });
* var example = new Aws.Neptune.ClusterInstance("example", new()
* {
* ClusterIdentifier = @default.Id,
* Engine = "neptune",
* InstanceClass = "db.r4.large",
* ApplyImmediately = true,
* });
* var defaultTopic = new Aws.Sns.Topic("default", new()
* {
* Name = "neptune-events",
* });
* var defaultEventSubscription = new Aws.Neptune.EventSubscription("default", new()
* {
* Name = "neptune-event-sub",
* SnsTopicArn = defaultTopic.Arn,
* SourceType = "db-instance",
* SourceIds = new[]
* {
* example.Id,
* },
* EventCategories = new[]
* {
* "maintenance",
* "availability",
* "creation",
* "backup",
* "restoration",
* "recovery",
* "deletion",
* "failover",
* "failure",
* "notification",
* "configuration change",
* "read replica",
* },
* Tags =
* {
* { "env", "test" },
* },
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-aws/sdk/v6/go/aws/neptune"
* "github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sns"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _, err := neptune.NewCluster(ctx, "default", &neptune.ClusterArgs{
* ClusterIdentifier: pulumi.String("neptune-cluster-demo"),
* Engine: pulumi.String("neptune"),
* BackupRetentionPeriod: pulumi.Int(5),
* PreferredBackupWindow: pulumi.String("07:00-09:00"),
* SkipFinalSnapshot: pulumi.Bool(true),
* IamDatabaseAuthenticationEnabled: pulumi.Bool(true),
* ApplyImmediately: pulumi.Bool(true),
* })
* if err != nil {
* return err
* }
* example, err := neptune.NewClusterInstance(ctx, "example", &neptune.ClusterInstanceArgs{
* ClusterIdentifier: _default.ID(),
* Engine: pulumi.String("neptune"),
* InstanceClass: pulumi.String("db.r4.large"),
* ApplyImmediately: pulumi.Bool(true),
* })
* if err != nil {
* return err
* }
* defaultTopic, err := sns.NewTopic(ctx, "default", &sns.TopicArgs{
* Name: pulumi.String("neptune-events"),
* })
* if err != nil {
* return err
* }
* _, err = neptune.NewEventSubscription(ctx, "default", &neptune.EventSubscriptionArgs{
* Name: pulumi.String("neptune-event-sub"),
* SnsTopicArn: defaultTopic.Arn,
* SourceType: pulumi.String("db-instance"),
* SourceIds: pulumi.StringArray{
* example.ID(),
* },
* EventCategories: pulumi.StringArray{
* pulumi.String("maintenance"),
* pulumi.String("availability"),
* pulumi.String("creation"),
* pulumi.String("backup"),
* pulumi.String("restoration"),
* pulumi.String("recovery"),
* pulumi.String("deletion"),
* pulumi.String("failover"),
* pulumi.String("failure"),
* pulumi.String("notification"),
* pulumi.String("configuration change"),
* pulumi.String("read replica"),
* },
* Tags: pulumi.StringMap{
* "env": pulumi.String("test"),
* },
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* package generated_program;
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.aws.neptune.Cluster;
* import com.pulumi.aws.neptune.ClusterArgs;
* import com.pulumi.aws.neptune.ClusterInstance;
* import com.pulumi.aws.neptune.ClusterInstanceArgs;
* import com.pulumi.aws.sns.Topic;
* import com.pulumi.aws.sns.TopicArgs;
* import com.pulumi.aws.neptune.EventSubscription;
* import com.pulumi.aws.neptune.EventSubscriptionArgs;
* import java.util.List;
* import java.util.ArrayList;
* import java.util.Map;
* import java.io.File;
* import java.nio.file.Files;
* import java.nio.file.Paths;
* public class App {
* public static void main(String[] args) {
* Pulumi.run(App::stack);
* }
* public static void stack(Context ctx) {
* var default_ = new Cluster("default", ClusterArgs.builder()
* .clusterIdentifier("neptune-cluster-demo")
* .engine("neptune")
* .backupRetentionPeriod(5)
* .preferredBackupWindow("07:00-09:00")
* .skipFinalSnapshot(true)
* .iamDatabaseAuthenticationEnabled("true")
* .applyImmediately("true")
* .build());
* var example = new ClusterInstance("example", ClusterInstanceArgs.builder()
* .clusterIdentifier(default_.id())
* .engine("neptune")
* .instanceClass("db.r4.large")
* .applyImmediately("true")
* .build());
* var defaultTopic = new Topic("defaultTopic", TopicArgs.builder()
* .name("neptune-events")
* .build());
* var defaultEventSubscription = new EventSubscription("defaultEventSubscription", EventSubscriptionArgs.builder()
* .name("neptune-event-sub")
* .snsTopicArn(defaultTopic.arn())
* .sourceType("db-instance")
* .sourceIds(example.id())
* .eventCategories(
* "maintenance",
* "availability",
* "creation",
* "backup",
* "restoration",
* "recovery",
* "deletion",
* "failover",
* "failure",
* "notification",
* "configuration change",
* "read replica")
* .tags(Map.of("env", "test"))
* .build());
* }
* }
* ```
* ```yaml
* resources:
* default:
* type: aws:neptune:Cluster
* properties:
* clusterIdentifier: neptune-cluster-demo
* engine: neptune
* backupRetentionPeriod: 5
* preferredBackupWindow: 07:00-09:00
* skipFinalSnapshot: true
* iamDatabaseAuthenticationEnabled: 'true'
* applyImmediately: 'true'
* example:
* type: aws:neptune:ClusterInstance
* properties:
* clusterIdentifier: ${default.id}
* engine: neptune
* instanceClass: db.r4.large
* applyImmediately: 'true'
* defaultTopic:
* type: aws:sns:Topic
* name: default
* properties:
* name: neptune-events
* defaultEventSubscription:
* type: aws:neptune:EventSubscription
* name: default
* properties:
* name: neptune-event-sub
* snsTopicArn: ${defaultTopic.arn}
* sourceType: db-instance
* sourceIds:
* - ${example.id}
* eventCategories:
* - maintenance
* - availability
* - creation
* - backup
* - restoration
* - recovery
* - deletion
* - failover
* - failure
* - notification
* - configuration change
* - read replica
* tags:
* env: test
* ```
*
* ## Import
* Using `pulumi import`, import `aws_neptune_event_subscription` using the event subscription name. For example:
* ```sh
* $ pulumi import aws:neptune/eventSubscription:EventSubscription example my-event-subscription
* ```
*/
public class EventSubscription internal constructor(
override val javaResource: com.pulumi.aws.neptune.EventSubscription,
) : KotlinCustomResource(javaResource, EventSubscriptionMapper) {
/**
* The Amazon Resource Name of the Neptune event notification subscription.
*/
public val arn: Output
get() = javaResource.arn().applyValue({ args0 -> args0 })
/**
* The AWS customer account associated with the Neptune event notification subscription.
*/
public val customerAwsId: Output
get() = javaResource.customerAwsId().applyValue({ args0 -> args0 })
/**
* A boolean flag to enable/disable the subscription. Defaults to true.
*/
public val enabled: Output?
get() = javaResource.enabled().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* A list of event categories for a `source_type` that you want to subscribe to. Run `aws neptune describe-event-categories` to find all the event categories.
*/
public val eventCategories: Output>?
get() = javaResource.eventCategories().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 -> args0 })
}).orElse(null)
})
/**
* The name of the Neptune event subscription. By default generated by this provider.
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* The name of the Neptune event subscription. Conflicts with `name`.
*/
public val namePrefix: Output
get() = javaResource.namePrefix().applyValue({ args0 -> args0 })
/**
* The ARN of the SNS topic to send events to.
*/
public val snsTopicArn: Output
get() = javaResource.snsTopicArn().applyValue({ args0 -> args0 })
/**
* A list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. If specified, a `source_type` must also be specified.
*/
public val sourceIds: Output>?
get() = javaResource.sourceIds().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0
})
}).orElse(null)
})
/**
* The type of source that will be generating the events. Valid options are `db-instance`, `db-security-group`, `db-parameter-group`, `db-snapshot`, `db-cluster` or `db-cluster-snapshot`. If not set, all sources will be subscribed to.
*/
public val sourceType: Output?
get() = javaResource.sourceType().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* A map of tags to assign to the resource. .If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
public val tags: Output>?
get() = javaResource.tags().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
}).orElse(null)
})
/**
* A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.
*/
@Deprecated(
message = """
Please use `tags` instead.
""",
)
public val tagsAll: Output>
get() = javaResource.tagsAll().applyValue({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
})
}
public object EventSubscriptionMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.aws.neptune.EventSubscription::class == javaResource::class
override fun map(javaResource: Resource): EventSubscription = EventSubscription(
javaResource as
com.pulumi.aws.neptune.EventSubscription,
)
}
/**
* @see [EventSubscription].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [EventSubscription].
*/
public suspend fun eventSubscription(
name: String,
block: suspend EventSubscriptionResourceBuilder.() -> Unit,
): EventSubscription {
val builder = EventSubscriptionResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [EventSubscription].
* @param name The _unique_ name of the resulting resource.
*/
public fun eventSubscription(name: String): EventSubscription {
val builder = EventSubscriptionResourceBuilder()
builder.name(name)
return builder.build()
}
