Package software.amazon.awscdk.services.redshift

Interface CfnCluster.LoggingPropertiesProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCluster.LoggingPropertiesProperty.Jsii$Proxy

Enclosing class:

CfnCluster

@Stability(Stable)
public static interface CfnCluster.LoggingPropertiesProperty
extends software.amazon.jsii.JsiiSerializable

Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.redshift.*;
 LoggingPropertiesProperty loggingPropertiesProperty = LoggingPropertiesProperty.builder()
         .bucketName("bucketName")
         .logDestinationType("logDestinationType")
         .logExports(List.of("logExports"))
         .s3KeyPrefix("s3KeyPrefix")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-cluster-loggingproperties.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnCluster.LoggingPropertiesProperty.Builder	A builder for CfnCluster.LoggingPropertiesProperty
static final class	CfnCluster.LoggingPropertiesProperty.Jsii$Proxy	An implementation for CfnCluster.LoggingPropertiesProperty

Method Summary

Modifier and Type	Method	Description
static CfnCluster.LoggingPropertiesProperty.Builder	builder()
default String	getBucketName()	The name of an existing S3 bucket where the log files are to be stored.
default String	getLogDestinationType()	The log destination type.
default List<String>	getLogExports()	The collection of exported log types.
default String	getS3KeyPrefix()	The prefix applied to the log file names.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBucketName

@Stability(Stable)
@Nullable
default String getBucketName()

The name of an existing S3 bucket where the log files are to be stored.

Constraints:

• Must be in the same region as the cluster
• The cluster must have read bucket and put object permissions

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-cluster-loggingproperties.html#cfn-redshift-cluster-loggingproperties-bucketname

getLogDestinationType

@Stability(Stable)
@Nullable
default String getLogDestinationType()

The log destination type.

An enum with possible values of s3 and cloudwatch .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-cluster-loggingproperties.html#cfn-redshift-cluster-loggingproperties-logdestinationtype

getLogExports

@Stability(Stable)
@Nullable
default List<String> getLogExports()

The collection of exported log types.

Possible values are connectionlog , useractivitylog , and userlog .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-cluster-loggingproperties.html#cfn-redshift-cluster-loggingproperties-logexports

getS3KeyPrefix

@Stability(Stable)
@Nullable
default String getS3KeyPrefix()

The prefix applied to the log file names.

Constraints:

• Cannot exceed 512 characters
• Cannot contain spaces( ), double quotes ("), single quotes ('), a backslash (), or control characters. The hexadecimal codes for invalid characters are:
• x00 to x20
• x22
• x27
• x5c
• x7f or larger

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-cluster-loggingproperties.html#cfn-redshift-cluster-loggingproperties-s3keyprefix

builder

@Stability(Stable)
static CfnCluster.LoggingPropertiesProperty.Builder builder()

Returns:

a CfnCluster.LoggingPropertiesProperty.Builder of CfnCluster.LoggingPropertiesProperty