Logging class

Resource for managing an AWS Redshift Logging configuration.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.redshift.Logging("example", {
    clusterIdentifier: exampleAwsRedshiftCluster.id,
    logDestinationType: "cloudwatch",
    logExports: [
        "connectionlog",
        "userlog",
    ],
});
import pulumi
import pulumi_aws as aws

example = aws.redshift.Logging("example",
    cluster_identifier=example_aws_redshift_cluster["id"],
    log_destination_type="cloudwatch",
    log_exports=[
        "connectionlog",
        "userlog",
    ])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.RedShift.Logging("example", new()
    {
        ClusterIdentifier = exampleAwsRedshiftCluster.Id,
        LogDestinationType = "cloudwatch",
        LogExports = new[]
        {
            "connectionlog",
            "userlog",
        },
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/redshift"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := redshift.NewLogging(ctx, "example", &redshift.LoggingArgs{
			ClusterIdentifier:  pulumi.Any(exampleAwsRedshiftCluster.Id),
			LogDestinationType: pulumi.String("cloudwatch"),
			LogExports: pulumi.StringArray{
				pulumi.String("connectionlog"),
				pulumi.String("userlog"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_redshift_logging" "example" {
  cluster_identifier   = exampleAwsRedshiftCluster.id
  log_destination_type = "cloudwatch"
  log_exports          = ["connectionlog", "userlog"]
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.redshift.Logging;
import com.pulumi.aws.redshift.LoggingArgs;
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 example = new Logging("example", LoggingArgs.builder()
            .clusterIdentifier(exampleAwsRedshiftCluster.id())
            .logDestinationType("cloudwatch")
            .logExports(
                "connectionlog",
                "userlog")
            .build());

    }
}
resources:
  example:
    type: aws:redshift:Logging
    properties:
      clusterIdentifier: ${exampleAwsRedshiftCluster.id}
      logDestinationType: cloudwatch
      logExports:
        - connectionlog
        - userlog

S3 Destination Type

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.redshift.Logging("example", {
    clusterIdentifier: exampleAwsRedshiftCluster.id,
    logDestinationType: "s3",
    bucketName: exampleAwsS3Bucket.id,
    s3KeyPrefix: "example-prefix/",
});
import pulumi
import pulumi_aws as aws

example = aws.redshift.Logging("example",
    cluster_identifier=example_aws_redshift_cluster["id"],
    log_destination_type="s3",
    bucket_name=example_aws_s3_bucket["id"],
    s3_key_prefix="example-prefix/")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.RedShift.Logging("example", new()
    {
        ClusterIdentifier = exampleAwsRedshiftCluster.Id,
        LogDestinationType = "s3",
        BucketName = exampleAwsS3Bucket.Id,
        S3KeyPrefix = "example-prefix/",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/redshift"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := redshift.NewLogging(ctx, "example", &redshift.LoggingArgs{
			ClusterIdentifier:  pulumi.Any(exampleAwsRedshiftCluster.Id),
			LogDestinationType: pulumi.String("s3"),
			BucketName:         pulumi.Any(exampleAwsS3Bucket.Id),
			S3KeyPrefix:        pulumi.String("example-prefix/"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_redshift_logging" "example" {
  cluster_identifier   = exampleAwsRedshiftCluster.id
  log_destination_type = "s3"
  bucket_name          = exampleAwsS3Bucket.id
  s3_key_prefix        = "example-prefix/"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.redshift.Logging;
import com.pulumi.aws.redshift.LoggingArgs;
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 example = new Logging("example", LoggingArgs.builder()
            .clusterIdentifier(exampleAwsRedshiftCluster.id())
            .logDestinationType("s3")
            .bucketName(exampleAwsS3Bucket.id())
            .s3KeyPrefix("example-prefix/")
            .build());

    }
}
resources:
  example:
    type: aws:redshift:Logging
    properties:
      clusterIdentifier: ${exampleAwsRedshiftCluster.id}
      logDestinationType: s3
      bucketName: ${exampleAwsS3Bucket.id}
      s3KeyPrefix: example-prefix/

Import

Using pulumi import, import Redshift Logging using the id. For example:

$ pulumi import aws:redshift/logging:Logging example cluster-id-12345678

Constructors

Logging(String name, {LoggingArgs? args, CustomResourceOptions? options})
Creates a new Logging. name The Pulumi resource name. args Arguments used to configure this Logging. The set of arguments for Logging. options Resource options controlling this resource's behavior.
Logging.reference(String urn)
Creates a typed reference to an existing Logging resource.

Properties

bucketName ↔ Output<String?>
Name of an existing S3 bucket where the log files are to be stored. Required when logDestinationType is s3. Must be in the same region as the cluster and the cluster must have read bucket and put object permissions. For more information on the permissions required for the bucket, please read the AWS documentation
latefinal
childResources → Set<Resource>
finalinherited
clusterIdentifier ↔ Output<String>
Identifier of the source cluster.
latefinal
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
logDestinationType ↔ Output<String?>
Log destination type. Valid values are s3 and cloudwatch.
latefinal
logExports ↔ Output<List<String>?>
Collection of exported log types. Required when logDestinationType is cloudwatch. Valid values are connectionlog, useractivitylog, and userlog.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
s3KeyPrefix ↔ Output<String?>
Prefix applied to the log file names.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {LoggingState? state, CustomResourceOptions? options}) → Logging
Gets an existing Logging resource's state with the given name and id.