Class: AWSCDK::APIGatewayv2::CfnStage::AccessLogSettingsProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::APIGatewayv2::CfnStage::AccessLogSettingsProperty

Defined in:

api_gatewayv2/cfn_stage.rb

Overview

Settings for logging access in a stage.

See Also:

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

Instance Attribute Summary

• #destination_arn ⇒ String^? readonly

  The ARN of the CloudWatch Logs log group 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) ⇒ AccessLogSettingsProperty constructor

  A new instance of AccessLogSettingsProperty.

• #to_jsii ⇒ Object

Constructor Details

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

Returns a new instance of AccessLogSettingsProperty.

Parameters:

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

  The ARN of the CloudWatch Logs log group 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.

# File 'api_gatewayv2/cfn_stage.rb', line 649

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 ARN of the CloudWatch Logs log group to receive access logs.

This parameter is required to enable access logging.

Returns:

• (String, nil)

See Also:

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

# File 'api_gatewayv2/cfn_stage.rb', line 662

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-apigatewayv2-stage-accesslogsettings.html#cfn-apigatewayv2-stage-accesslogsettings-format

# File 'api_gatewayv2/cfn_stage.rb', line 669

def format
  @format
end

Class Method Details

.jsii_properties ⇒ Object

# File 'api_gatewayv2/cfn_stage.rb', line 671

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

Instance Method Details

#to_jsii ⇒ Object

# File 'api_gatewayv2/cfn_stage.rb', line 678

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