Class: AWSCDK::APIGateway::CfnStage::AccessLogSettingProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::APIGateway::CfnStage::AccessLogSettingProperty

Defined in:

api_gateway/cfn_stage.rb

Overview

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

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

See Also:

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

Instance Attribute Summary

• #destination_arn ⇒ String^? readonly

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

• #format ⇒ String^? readonly

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

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(destination_arn: nil, format: nil) ⇒ AccessLogSettingProperty constructor

  A new instance of AccessLogSettingProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(destination_arn: nil, format: nil) ⇒ AccessLogSettingProperty

Returns a new instance of AccessLogSettingProperty.

Parameters:

• destination_arn (String, nil) (defaults to: nil) —

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

• format (String, nil) (defaults to: nil) —

  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.

# File 'api_gateway/cfn_stage.rb', line 676

def initialize(destination_arn: nil, format: nil)
  @destination_arn = destination_arn
  Jsii::Type.check_type(@destination_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "destinationArn") unless @destination_arn.nil?
  @format = format
  Jsii::Type.check_type(@format, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "format") unless @format.nil?
end

Instance Attribute Details

#destination_arn ⇒ String^? (readonly)

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

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.

Returns:

• (String, nil)

See Also:

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

# File 'api_gateway/cfn_stage.rb', line 689

def destination_arn
  @destination_arn
end

#format ⇒ String^? (readonly)

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.

Returns:

• (String, nil)

See Also:

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

# File 'api_gateway/cfn_stage.rb', line 694

def format
  @format
end

Class Method Details

.jsii_properties ⇒ Object

# File 'api_gateway/cfn_stage.rb', line 696

def self.jsii_properties
  {
    :destination_arn => "destinationArn",
    :format => "format",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'api_gateway/cfn_stage.rb', line 703

def to_jsii
  result = {}
  result.merge!({
    "destinationArn" => @destination_arn,
    "format" => @format,
  })
  result.compact
end