Class CfnDeployment.AccessLogSettingProperty

The AccessLogSetting property type specifies settings for logging access in this stage.

Inheritance

object

CfnDeployment.AccessLogSettingProperty

Implements

CfnDeployment.IAccessLogSettingProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.APIGateway

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnDeployment.AccessLogSettingProperty : CfnDeployment.IAccessLogSettingProperty

Syntax (vb)

Public Class CfnDeployment.AccessLogSettingProperty Implements CfnDeployment.IAccessLogSettingProperty

Remarks

AccessLogSetting is a property of the StageDescription property type.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-accesslogsetting.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.APIGateway;

             var accessLogSettingProperty = new AccessLogSettingProperty {
                 DestinationArn = "destinationArn",
                 Format = "format"
             };

Synopsis

Constructors

AccessLogSettingProperty()

The AccessLogSetting property type specifies settings for logging access in this stage.

Properties

DestinationArn	The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs.
Format	A single line format of the access logs of data, as specified by selected $context variables.

Constructors

AccessLogSettingProperty()

The AccessLogSetting property type specifies settings for logging access in this stage.

public AccessLogSettingProperty()

Remarks

AccessLogSetting is a property of the StageDescription property type.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-accesslogsetting.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.APIGateway;

             var accessLogSettingProperty = new AccessLogSettingProperty {
                 DestinationArn = "destinationArn",
                 Format = "format"
             };

Properties

DestinationArn

The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs.

public string? DestinationArn { get; set; }

Property Value

string

Remarks

If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with amazon-apigateway- .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-accesslogsetting.html#cfn-apigateway-deployment-accesslogsetting-destinationarn

Format

A single line format of the access logs of data, as specified by selected $context variables.

public string? Format { get; set; }

Property Value

string

Remarks

The format must include at least $context.requestId .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-accesslogsetting.html#cfn-apigateway-deployment-accesslogsetting-format

Implements

CfnDeployment.IAccessLogSettingProperty