aws.rds.ClusterActivityStream
Explore with Pulumi AI
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 documentation for detailed limitations and requirements.
Note: This resource always calls the RDS [
StartActivityStream
][2] API with theApplyImmediately
parameter set totrue
. 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 resourcedepends_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
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const _default = new aws.rds.Cluster("default", {
clusterIdentifier: "aurora-cluster-demo",
availabilityZones: [
"us-west-2a",
"us-west-2b",
"us-west-2c",
],
databaseName: "mydb",
masterUsername: "foo",
masterPassword: "mustbeeightcharaters",
engine: aws.rds.EngineType.AuroraPostgresql,
engineVersion: "13.4",
});
const defaultClusterInstance = new aws.rds.ClusterInstance("default", {
identifier: "aurora-instance-demo",
clusterIdentifier: _default.clusterIdentifier,
engine: _default.engine,
instanceClass: aws.rds.InstanceType.R6G_Large,
});
const defaultKey = new aws.kms.Key("default", {description: "AWS KMS Key to encrypt Database Activity Stream"});
const defaultClusterActivityStream = new aws.rds.ClusterActivityStream("default", {
resourceArn: _default.arn,
mode: "async",
kmsKeyId: defaultKey.keyId,
}, {
dependsOn: [defaultClusterInstance],
});
import pulumi
import pulumi_aws as aws
default = aws.rds.Cluster("default",
cluster_identifier="aurora-cluster-demo",
availability_zones=[
"us-west-2a",
"us-west-2b",
"us-west-2c",
],
database_name="mydb",
master_username="foo",
master_password="mustbeeightcharaters",
engine=aws.rds.EngineType.AURORA_POSTGRESQL,
engine_version="13.4")
default_cluster_instance = aws.rds.ClusterInstance("default",
identifier="aurora-instance-demo",
cluster_identifier=default.cluster_identifier,
engine=default.engine,
instance_class=aws.rds.InstanceType.R6_G_LARGE)
default_key = aws.kms.Key("default", description="AWS KMS Key to encrypt Database Activity Stream")
default_cluster_activity_stream = aws.rds.ClusterActivityStream("default",
resource_arn=default.arn,
mode="async",
kms_key_id=default_key.key_id,
opts = pulumi.ResourceOptions(depends_on=[default_cluster_instance]))
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/kms"
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/rds"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := rds.NewCluster(ctx, "default", &rds.ClusterArgs{
ClusterIdentifier: pulumi.String("aurora-cluster-demo"),
AvailabilityZones: pulumi.StringArray{
pulumi.String("us-west-2a"),
pulumi.String("us-west-2b"),
pulumi.String("us-west-2c"),
},
DatabaseName: pulumi.String("mydb"),
MasterUsername: pulumi.String("foo"),
MasterPassword: pulumi.String("mustbeeightcharaters"),
Engine: pulumi.String(rds.EngineTypeAuroraPostgresql),
EngineVersion: pulumi.String("13.4"),
})
if err != nil {
return err
}
defaultClusterInstance, err := rds.NewClusterInstance(ctx, "default", &rds.ClusterInstanceArgs{
Identifier: pulumi.String("aurora-instance-demo"),
ClusterIdentifier: _default.ClusterIdentifier,
Engine: _default.Engine,
InstanceClass: pulumi.String(rds.InstanceType_R6G_Large),
})
if err != nil {
return err
}
defaultKey, err := kms.NewKey(ctx, "default", &kms.KeyArgs{
Description: pulumi.String("AWS KMS Key to encrypt Database Activity Stream"),
})
if err != nil {
return err
}
_, err = rds.NewClusterActivityStream(ctx, "default", &rds.ClusterActivityStreamArgs{
ResourceArn: _default.Arn,
Mode: pulumi.String("async"),
KmsKeyId: defaultKey.KeyId,
}, pulumi.DependsOn([]pulumi.Resource{
defaultClusterInstance,
}))
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var @default = new Aws.Rds.Cluster("default", new()
{
ClusterIdentifier = "aurora-cluster-demo",
AvailabilityZones = new[]
{
"us-west-2a",
"us-west-2b",
"us-west-2c",
},
DatabaseName = "mydb",
MasterUsername = "foo",
MasterPassword = "mustbeeightcharaters",
Engine = Aws.Rds.EngineType.AuroraPostgresql,
EngineVersion = "13.4",
});
var defaultClusterInstance = new Aws.Rds.ClusterInstance("default", new()
{
Identifier = "aurora-instance-demo",
ClusterIdentifier = @default.ClusterIdentifier,
Engine = @default.Engine,
InstanceClass = Aws.Rds.InstanceType.R6G_Large,
});
var defaultKey = new Aws.Kms.Key("default", new()
{
Description = "AWS KMS Key to encrypt Database Activity Stream",
});
var defaultClusterActivityStream = new Aws.Rds.ClusterActivityStream("default", new()
{
ResourceArn = @default.Arn,
Mode = "async",
KmsKeyId = defaultKey.KeyId,
}, new CustomResourceOptions
{
DependsOn =
{
defaultClusterInstance,
},
});
});
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());
}
}
resources:
default:
type: aws:rds:Cluster
properties:
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'
defaultClusterInstance:
type: aws:rds:ClusterInstance
name: default
properties:
identifier: aurora-instance-demo
clusterIdentifier: ${default.clusterIdentifier}
engine: ${default.engine}
instanceClass: db.r6g.large
defaultKey:
type: aws:kms:Key
name: default
properties:
description: AWS KMS Key to encrypt Database Activity Stream
defaultClusterActivityStream:
type: aws:rds:ClusterActivityStream
name: default
properties:
resourceArn: ${default.arn}
mode: async
kmsKeyId: ${defaultKey.keyId}
options:
dependson:
- ${defaultClusterInstance}
Create ClusterActivityStream Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ClusterActivityStream(name: string, args: ClusterActivityStreamArgs, opts?: CustomResourceOptions);
@overload
def ClusterActivityStream(resource_name: str,
args: ClusterActivityStreamArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ClusterActivityStream(resource_name: str,
opts: Optional[ResourceOptions] = None,
kms_key_id: Optional[str] = None,
mode: Optional[str] = None,
resource_arn: Optional[str] = None,
engine_native_audit_fields_included: Optional[bool] = None)
func NewClusterActivityStream(ctx *Context, name string, args ClusterActivityStreamArgs, opts ...ResourceOption) (*ClusterActivityStream, error)
public ClusterActivityStream(string name, ClusterActivityStreamArgs args, CustomResourceOptions? opts = null)
public ClusterActivityStream(String name, ClusterActivityStreamArgs args)
public ClusterActivityStream(String name, ClusterActivityStreamArgs args, CustomResourceOptions options)
type: aws:rds:ClusterActivityStream
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ClusterActivityStreamArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ClusterActivityStreamArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ClusterActivityStreamArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ClusterActivityStreamArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ClusterActivityStreamArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var clusterActivityStreamResource = new Aws.Rds.ClusterActivityStream("clusterActivityStreamResource", new()
{
KmsKeyId = "string",
Mode = "string",
ResourceArn = "string",
EngineNativeAuditFieldsIncluded = false,
});
example, err := rds.NewClusterActivityStream(ctx, "clusterActivityStreamResource", &rds.ClusterActivityStreamArgs{
KmsKeyId: pulumi.String("string"),
Mode: pulumi.String("string"),
ResourceArn: pulumi.String("string"),
EngineNativeAuditFieldsIncluded: pulumi.Bool(false),
})
var clusterActivityStreamResource = new ClusterActivityStream("clusterActivityStreamResource", ClusterActivityStreamArgs.builder()
.kmsKeyId("string")
.mode("string")
.resourceArn("string")
.engineNativeAuditFieldsIncluded(false)
.build());
cluster_activity_stream_resource = aws.rds.ClusterActivityStream("clusterActivityStreamResource",
kms_key_id="string",
mode="string",
resource_arn="string",
engine_native_audit_fields_included=False)
const clusterActivityStreamResource = new aws.rds.ClusterActivityStream("clusterActivityStreamResource", {
kmsKeyId: "string",
mode: "string",
resourceArn: "string",
engineNativeAuditFieldsIncluded: false,
});
type: aws:rds:ClusterActivityStream
properties:
engineNativeAuditFieldsIncluded: false
kmsKeyId: string
mode: string
resourceArn: string
ClusterActivityStream Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The ClusterActivityStream resource accepts the following input properties:
- Kms
Key stringId - 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.
- Mode string
- 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
. - Resource
Arn string - The Amazon Resource Name (ARN) of the DB cluster.
- Engine
Native boolAudit Fields Included - 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
.
- Kms
Key stringId - 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.
- Mode string
- 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
. - Resource
Arn string - The Amazon Resource Name (ARN) of the DB cluster.
- Engine
Native boolAudit Fields Included - 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
.
- kms
Key StringId - 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.
- mode String
- 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
. - resource
Arn String - The Amazon Resource Name (ARN) of the DB cluster.
- engine
Native BooleanAudit Fields Included - 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
.
- kms
Key stringId - 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.
- mode string
- 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
. - resource
Arn string - The Amazon Resource Name (ARN) of the DB cluster.
- engine
Native booleanAudit Fields Included - 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
.
- kms_
key_ strid - 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.
- mode str
- 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
. - resource_
arn str - The Amazon Resource Name (ARN) of the DB cluster.
- engine_
native_ boolaudit_ fields_ included - 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
.
- kms
Key StringId - 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.
- mode String
- 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
. - resource
Arn String - The Amazon Resource Name (ARN) of the DB cluster.
- engine
Native BooleanAudit Fields Included - 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
.
Outputs
All input properties are implicitly available as output properties. Additionally, the ClusterActivityStream resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Kinesis
Stream stringName - The name of the Amazon Kinesis data stream to be used for the database activity stream.
- Id string
- The provider-assigned unique ID for this managed resource.
- Kinesis
Stream stringName - The name of the Amazon Kinesis data stream to be used for the database activity stream.
- id String
- The provider-assigned unique ID for this managed resource.
- kinesis
Stream StringName - The name of the Amazon Kinesis data stream to be used for the database activity stream.
- id string
- The provider-assigned unique ID for this managed resource.
- kinesis
Stream stringName - The name of the Amazon Kinesis data stream to be used for the database activity stream.
- id str
- The provider-assigned unique ID for this managed resource.
- kinesis_
stream_ strname - The name of the Amazon Kinesis data stream to be used for the database activity stream.
- id String
- The provider-assigned unique ID for this managed resource.
- kinesis
Stream StringName - The name of the Amazon Kinesis data stream to be used for the database activity stream.
Look up Existing ClusterActivityStream Resource
Get an existing ClusterActivityStream resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ClusterActivityStreamState, opts?: CustomResourceOptions): ClusterActivityStream
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
engine_native_audit_fields_included: Optional[bool] = None,
kinesis_stream_name: Optional[str] = None,
kms_key_id: Optional[str] = None,
mode: Optional[str] = None,
resource_arn: Optional[str] = None) -> ClusterActivityStream
func GetClusterActivityStream(ctx *Context, name string, id IDInput, state *ClusterActivityStreamState, opts ...ResourceOption) (*ClusterActivityStream, error)
public static ClusterActivityStream Get(string name, Input<string> id, ClusterActivityStreamState? state, CustomResourceOptions? opts = null)
public static ClusterActivityStream get(String name, Output<String> id, ClusterActivityStreamState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Engine
Native boolAudit Fields Included - 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
. - Kinesis
Stream stringName - The name of the Amazon Kinesis data stream to be used for the database activity stream.
- Kms
Key stringId - 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.
- Mode string
- 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
. - Resource
Arn string - The Amazon Resource Name (ARN) of the DB cluster.
- Engine
Native boolAudit Fields Included - 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
. - Kinesis
Stream stringName - The name of the Amazon Kinesis data stream to be used for the database activity stream.
- Kms
Key stringId - 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.
- Mode string
- 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
. - Resource
Arn string - The Amazon Resource Name (ARN) of the DB cluster.
- engine
Native BooleanAudit Fields Included - 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
. - kinesis
Stream StringName - The name of the Amazon Kinesis data stream to be used for the database activity stream.
- kms
Key StringId - 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.
- mode String
- 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
. - resource
Arn String - The Amazon Resource Name (ARN) of the DB cluster.
- engine
Native booleanAudit Fields Included - 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
. - kinesis
Stream stringName - The name of the Amazon Kinesis data stream to be used for the database activity stream.
- kms
Key stringId - 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.
- mode string
- 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
. - resource
Arn string - The Amazon Resource Name (ARN) of the DB cluster.
- engine_
native_ boolaudit_ fields_ included - 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
. - kinesis_
stream_ strname - The name of the Amazon Kinesis data stream to be used for the database activity stream.
- kms_
key_ strid - 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.
- mode str
- 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
. - resource_
arn str - The Amazon Resource Name (ARN) of the DB cluster.
- engine
Native BooleanAudit Fields Included - 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
. - kinesis
Stream StringName - The name of the Amazon Kinesis data stream to be used for the database activity stream.
- kms
Key StringId - 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.
- mode String
- 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
. - resource
Arn String - The Amazon Resource Name (ARN) of the DB cluster.
Import
Using pulumi import
, import RDS Aurora Cluster Database Activity Streams using the resource_arn
. For example:
$ pulumi import aws:rds/clusterActivityStream:ClusterActivityStream default arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster-demo
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.