Class ClusterActivityStream


  • public class ClusterActivityStream
    extends com.pulumi.resources.CustomResource
    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`](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_StartActivityStream.html) 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 `dependsOn` 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
     
     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.ArrayList;
     import java.util.Arrays;
     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());
     
         }
     }
     
     
    ## Import Using `pulumi import`, import RDS Aurora Cluster Database Activity Streams using the `resourceArn`. For example: ```sh $ pulumi import aws:rds/clusterActivityStream:ClusterActivityStream default arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster-demo ```
    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal
      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal
    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> engineNativeAuditFieldsIncluded()  
      static ClusterActivityStream get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ClusterActivityStreamState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> kinesisStreamName()  
      com.pulumi.core.Output<java.lang.String> kmsKeyId()  
      com.pulumi.core.Output<java.lang.String> mode()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> resourceArn()  
      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture
      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • ClusterActivityStream

        public ClusterActivityStream​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.
      • ClusterActivityStream

        public ClusterActivityStream​(java.lang.String name,
                                     ClusterActivityStreamArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
      • ClusterActivityStream

        public ClusterActivityStream​(java.lang.String name,
                                     ClusterActivityStreamArgs args,
                                     @Nullable
                                     com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.
    • Method Detail

      • engineNativeAuditFieldsIncluded

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> engineNativeAuditFieldsIncluded()
        Returns:
        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`.
      • kinesisStreamName

        public com.pulumi.core.Output<java.lang.String> kinesisStreamName()
        Returns:
        Name of the Amazon Kinesis data stream to be used for the database activity stream.
      • kmsKeyId

        public com.pulumi.core.Output<java.lang.String> kmsKeyId()
        Returns:
        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.
      • mode

        public com.pulumi.core.Output<java.lang.String> mode()
        Returns:
        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`.
      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
      • resourceArn

        public com.pulumi.core.Output<java.lang.String> resourceArn()
        Returns:
        ARN of the DB cluster.
      • get

        public static ClusterActivityStream get​(java.lang.String name,
                                                com.pulumi.core.Output<java.lang.String> id,
                                                @Nullable
                                                ClusterActivityStreamState state,
                                                @Nullable
                                                com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.