AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Note:

For PCL this operation is only available in asynchronous form. Please refer to EnableLoggingAsync.

Namespace: Amazon.Redshift
Assembly: AWSSDK.Redshift.dll
Version: 3.x.y.z

Syntax

C#
public abstract EnableLoggingResponse EnableLogging(
         EnableLoggingRequest request
)
Parameters
request
Type: Amazon.Redshift.Model.EnableLoggingRequest

Container for the necessary parameters to execute the EnableLogging service method.

Return Value
The response from the EnableLogging service method, as returned by Redshift.

Exceptions

ExceptionCondition
BucketNotFoundException Could not find the specified S3 bucket.
ClusterNotFoundException The ClusterIdentifier parameter does not refer to an existing cluster.
InsufficientS3BucketPolicyException The cluster does not have read bucket or put object permissions on the S3 bucket specified when enabling logging.
InvalidS3BucketNameException The S3 bucket name is invalid. For more information about naming rules, go to Bucket Restrictions and Limitations in the Amazon Simple Storage Service (S3) Developer Guide.
InvalidS3KeyPrefixException The string specified for the logging S3 key prefix does not comply with the documented constraints.

Examples

This example enables logging for the cluster mycluster using the Amazon S3 bucket aws-logs-112233445566-us-west-2.

To enable logging


var response = client.EnableLogging(new EnableLoggingRequest 
{
    BucketName = "aws-logs-112233445566-us-west-2",
    ClusterIdentifier = "mycluster"
});

string bucketName = response.BucketName;
bool loggingEnabled = response.LoggingEnabled;

            

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

See Also