Interface CfnStage.IAccessLogSettingProperty

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

Namespace: Amazon.CDK.AWS.APIGateway

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IAccessLogSettingProperty

Syntax (vb)

Public Interface IAccessLogSettingProperty

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-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

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 . The format must include at least $context.requestId . This parameter is required to enable access logging.

Properties

DestinationArn

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

virtual string DestinationArn { get; }

Property Value

System.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.

See: 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.

virtual string Format { get; }

Property Value

System.String

Remarks

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