Class CfnStage.AccessLogSettingProperty

Namespace

Amazon.CDK.AWS.APIGateway

Assembly

Amazon.CDK.AWS.APIGateway.dll

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

public class CfnStage.AccessLogSettingProperty : CfnStage.IAccessLogSettingProperty

Inheritance

object

CfnStage.AccessLogSettingProperty

Implements

CfnStage.IAccessLogSettingProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

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"
             };

Remarks

AccessLogSetting is a property of the AWS::ApiGateway::Stage resource.

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

ExampleMetadata: fixture=_generated

Constructors

AccessLogSettingProperty()

public AccessLogSettingProperty()

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- . This parameter is required to enable access logging.

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

Format

A single line format of the access logs of data, as specified by selected $context variables . The format must include at least $context.requestId . This parameter is required to enable access logging.

public string? Format { get; set; }

Property Value

string

Remarks

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