com.pulumi.aws.rds.ClusterActivityStream Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws Show documentation
Show all versions of aws Show documentation
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.aws.rds;
import com.pulumi.aws.Utilities;
import com.pulumi.aws.rds.ClusterActivityStreamArgs;
import com.pulumi.aws.rds.inputs.ClusterActivityStreamState;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import java.lang.Boolean;
import java.lang.String;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* Manages RDS Aurora Cluster Database Activity Streams.
*
* Database Activity Streams have some limits and requirements, refer to the [Monitoring Amazon Aurora using Database Activity Streams](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/DBActivityStreams.html) documentation for detailed limitations and requirements.
*
* > **Note:** This resource always calls the RDS [`StartActivityStream`][2] API with the `ApplyImmediately` parameter set to `true`. This is because the provider needs the activity stream to be started in order for it to get the associated attributes.
*
* > **Note:** This resource depends on having at least one `aws.rds.ClusterInstance` created. To avoid race conditions when all resources are being created together, add an explicit resource reference using the resource `depends_on` meta-argument.
*
* > **Note:** This resource is available in all regions except the following: `cn-north-1`, `cn-northwest-1`, `us-gov-east-1`, `us-gov-west-1`
*
* ## Example Usage
*
* <!--Start PulumiCodeChooser -->
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.aws.rds.Cluster;
* import com.pulumi.aws.rds.ClusterArgs;
* import com.pulumi.aws.rds.ClusterInstance;
* import com.pulumi.aws.rds.ClusterInstanceArgs;
* import com.pulumi.aws.kms.Key;
* import com.pulumi.aws.kms.KeyArgs;
* import com.pulumi.aws.rds.ClusterActivityStream;
* import com.pulumi.aws.rds.ClusterActivityStreamArgs;
* import com.pulumi.resources.CustomResourceOptions;
* 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("aurora-cluster-demo")
* .availabilityZones(
* "us-west-2a",
* "us-west-2b",
* "us-west-2c")
* .databaseName("mydb")
* .masterUsername("foo")
* .masterPassword("mustbeeightcharaters")
* .engine("aurora-postgresql")
* .engineVersion("13.4")
* .build());
*
* var defaultClusterInstance = new ClusterInstance("defaultClusterInstance", ClusterInstanceArgs.builder()
* .identifier("aurora-instance-demo")
* .clusterIdentifier(default_.clusterIdentifier())
* .engine(default_.engine())
* .instanceClass("db.r6g.large")
* .build());
*
* var defaultKey = new Key("defaultKey", KeyArgs.builder()
* .description("AWS KMS Key to encrypt Database Activity Stream")
* .build());
*
* var defaultClusterActivityStream = new ClusterActivityStream("defaultClusterActivityStream", ClusterActivityStreamArgs.builder()
* .resourceArn(default_.arn())
* .mode("async")
* .kmsKeyId(defaultKey.keyId())
* .build(), CustomResourceOptions.builder()
* .dependsOn(defaultClusterInstance)
* .build());
*
* }
* }
* }
*
* <!--End PulumiCodeChooser -->
*
* ## Import
*
* Using `pulumi import`, import RDS Aurora Cluster Database Activity Streams using the `resource_arn`. For example:
*
* ```sh
* $ pulumi import aws:rds/clusterActivityStream:ClusterActivityStream default arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster-demo
* ```
*
*/
@ResourceType(type="aws:rds/clusterActivityStream:ClusterActivityStream")
public class ClusterActivityStream extends com.pulumi.resources.CustomResource {
/**
* Specifies whether the database activity stream includes engine-native audit fields. This option only applies to an Oracle DB instance. By default, no engine-native audit fields are included. Defaults `false`.
*
*/
@Export(name="engineNativeAuditFieldsIncluded", refs={Boolean.class}, tree="[0]")
private Output engineNativeAuditFieldsIncluded;
/**
* @return Specifies whether the database activity stream includes engine-native audit fields. This option only applies to an Oracle DB instance. By default, no engine-native audit fields are included. Defaults `false`.
*
*/
public Output> engineNativeAuditFieldsIncluded() {
return Codegen.optional(this.engineNativeAuditFieldsIncluded);
}
/**
* The name of the Amazon Kinesis data stream to be used for the database activity stream.
*
*/
@Export(name="kinesisStreamName", refs={String.class}, tree="[0]")
private Output kinesisStreamName;
/**
* @return The name of the Amazon Kinesis data stream to be used for the database activity stream.
*
*/
public Output kinesisStreamName() {
return this.kinesisStreamName;
}
/**
* The AWS KMS key identifier for encrypting messages in the database activity stream. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
*
*/
@Export(name="kmsKeyId", refs={String.class}, tree="[0]")
private Output kmsKeyId;
/**
* @return The AWS KMS key identifier for encrypting messages in the database activity stream. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
*
*/
public Output kmsKeyId() {
return this.kmsKeyId;
}
/**
* Specifies the mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously. One of: `sync`, `async`.
*
*/
@Export(name="mode", refs={String.class}, tree="[0]")
private Output mode;
/**
* @return Specifies the mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously. One of: `sync`, `async`.
*
*/
public Output mode() {
return this.mode;
}
/**
* The Amazon Resource Name (ARN) of the DB cluster.
*
*/
@Export(name="resourceArn", refs={String.class}, tree="[0]")
private Output resourceArn;
/**
* @return The Amazon Resource Name (ARN) of the DB cluster.
*
*/
public Output resourceArn() {
return this.resourceArn;
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public ClusterActivityStream(java.lang.String name) {
this(name, ClusterActivityStreamArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public ClusterActivityStream(java.lang.String name, ClusterActivityStreamArgs args) {
this(name, args, null);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
* @param options A bag of options that control this resource's behavior.
*/
public ClusterActivityStream(java.lang.String name, ClusterActivityStreamArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("aws:rds/clusterActivityStream:ClusterActivityStream", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private ClusterActivityStream(java.lang.String name, Output id, @Nullable ClusterActivityStreamState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("aws:rds/clusterActivityStream:ClusterActivityStream", name, state, makeResourceOptions(options, id), false);
}
private static ClusterActivityStreamArgs makeArgs(ClusterActivityStreamArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
return args == null ? ClusterActivityStreamArgs.Empty : args;
}
private static com.pulumi.resources.CustomResourceOptions makeResourceOptions(@Nullable com.pulumi.resources.CustomResourceOptions options, @Nullable Output id) {
var defaultOptions = com.pulumi.resources.CustomResourceOptions.builder()
.version(Utilities.getVersion())
.build();
return com.pulumi.resources.CustomResourceOptions.merge(defaultOptions, options, id);
}
/**
* Get an existing Host resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state
* @param options Optional settings to control the behavior of the CustomResource.
*/
public static ClusterActivityStream get(java.lang.String name, Output id, @Nullable ClusterActivityStreamState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new ClusterActivityStream(name, id, state, options);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy