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.

Container for the parameters to the EnableLogging operation. Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Redshift.AmazonRedshiftRequest
      Amazon.Redshift.Model.EnableLoggingRequest

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

Syntax

C#
public class EnableLoggingRequest : AmazonRedshiftRequest
         IAmazonWebServiceRequest

The EnableLoggingRequest type exposes the following members

Constructors

NameDescription
Public Method EnableLoggingRequest()

Properties

NameTypeDescription
Public Property BucketName System.String

Gets and sets the property BucketName.

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

Public Property ClusterIdentifier System.String

Gets and sets the property ClusterIdentifier.

The identifier of the cluster on which logging is to be started.

Example: examplecluster

Public Property S3KeyPrefix System.String

Gets and sets the property S3KeyPrefix.

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

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 Standard:
Supported in: 1.3

.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