Class: AWSCDK::AppMesh::CfnVirtualGateway::VirtualGatewayFileAccessLogProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::AppMesh::CfnVirtualGateway::VirtualGatewayFileAccessLogProperty

Defined in:

app_mesh/cfn_virtual_gateway.rb

Overview

An object that represents an access log file.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewayfileaccesslog.html

Instance Attribute Summary

• #format ⇒ AWSCDK::IResolvable, ... readonly

  The specified format for the virtual gateway access logs.

• #path ⇒ String readonly

  The file path to write access logs to.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(path:, format: nil) ⇒ VirtualGatewayFileAccessLogProperty constructor

  A new instance of VirtualGatewayFileAccessLogProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(path:, format: nil) ⇒ VirtualGatewayFileAccessLogProperty

Returns a new instance of VirtualGatewayFileAccessLogProperty.

Parameters:

• path (String) —

  The file path to write access logs to.

• format (AWSCDK::IResolvable, AWSCDK::AppMesh::CfnVirtualGateway::LoggingFormatProperty, nil) (defaults to: nil) —

  The specified format for the virtual gateway access logs.

# File 'app_mesh/cfn_virtual_gateway.rb', line 1043

def initialize(path:, format: nil)
  @path = path
  Jsii::Type.check_type(@path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  @format = format.is_a?(Hash) ? ::AWSCDK::AppMesh::CfnVirtualGateway::LoggingFormatProperty.new(**format.transform_keys(&:to_sym)) : format
  Jsii::Type.check_type(@format, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBtZXNoLkNmblZpcnR1YWxHYXRld2F5LkxvZ2dpbmdGb3JtYXRQcm9wZXJ0eSJ9XX19")), "format") unless @format.nil?
end

Instance Attribute Details

#format ⇒ AWSCDK::IResolvable, ... (readonly)

The specified format for the virtual gateway access logs.

It can be either json_format or text_format .

Returns:

• (AWSCDK::IResolvable, AWSCDK::AppMesh::CfnVirtualGateway::LoggingFormatProperty, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewayfileaccesslog.html#cfn-appmesh-virtualgateway-virtualgatewayfileaccesslog-format

# File 'app_mesh/cfn_virtual_gateway.rb', line 1063

def format
  @format
end

#path ⇒ String (readonly)

The file path to write access logs to.

You can use /dev/stdout to send access logs to standard out and configure your Envoy container to use a log driver, such as awslogs , to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container's file system to write the files to disk.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewayfileaccesslog.html#cfn-appmesh-virtualgateway-virtualgatewayfileaccesslog-path

# File 'app_mesh/cfn_virtual_gateway.rb', line 1056

def path
  @path
end

Class Method Details

.jsii_properties ⇒ Object

# File 'app_mesh/cfn_virtual_gateway.rb', line 1065

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

Instance Method Details

#to_jsii ⇒ Object

# File 'app_mesh/cfn_virtual_gateway.rb', line 1072

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