Class: AWSCDK::CloudFormation::CfnGuardHook::S3LocationProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::CloudFormation::CfnGuardHook::S3LocationProperty

Defined in:

cloud_formation/cfn_guard_hook.rb

Overview

Specifies the S3 location where your Guard rules or input parameters are located.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-s3location.html

Instance Attribute Summary

• #uri ⇒ String readonly

  Specifies the S3 path to the file that contains your Guard rules or input parameters (in the form s3://<bucket name>/<file name> ).

• #version_id ⇒ String^? readonly

  For S3 buckets with versioning enabled, specifies the unique ID of the S3 object version to download your Guard rules or input parameters from.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(uri:, version_id: nil) ⇒ S3LocationProperty constructor

  A new instance of S3LocationProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(uri:, version_id: nil) ⇒ S3LocationProperty

Returns a new instance of S3LocationProperty.

Parameters:

• uri (String) —

  Specifies the S3 path to the file that contains your Guard rules or input parameters (in the form s3://<bucket name>/<file name> ).

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

  For S3 buckets with versioning enabled, specifies the unique ID of the S3 object version to download your Guard rules or input parameters from.

# File 'cloud_formation/cfn_guard_hook.rb', line 716

def initialize(uri:, version_id: nil)
  @uri = uri
  Jsii::Type.check_type(@uri, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "uri")
  @version_id = version_id
  Jsii::Type.check_type(@version_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "versionId") unless @version_id.nil?
end

Instance Attribute Details

#uri ⇒ String (readonly)

Specifies the S3 path to the file that contains your Guard rules or input parameters (in the form s3://<bucket name>/<file name> ).

For Guard rules, the object stored in S3 must have one of the following file extensions: .guard , .zip , or .tar.gz .

For input parameters, the object stored in S3 must have one of the following file extensions: .yaml , .json , .zip , or .tar.gz .

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-s3location.html#cfn-cloudformation-guardhook-s3location-uri

# File 'cloud_formation/cfn_guard_hook.rb', line 731

def uri
  @uri
end

#version_id ⇒ String^? (readonly)

For S3 buckets with versioning enabled, specifies the unique ID of the S3 object version to download your Guard rules or input parameters from.

The Guard Hook downloads files from S3 every time the Hook is invoked. To prevent accidental changes or deletions, we recommend using a version when configuring your Guard Hook.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-s3location.html#cfn-cloudformation-guardhook-s3location-versionid

# File 'cloud_formation/cfn_guard_hook.rb', line 738

def version_id
  @version_id
end

Class Method Details

.jsii_properties ⇒ Object

# File 'cloud_formation/cfn_guard_hook.rb', line 740

def self.jsii_properties
  {
    :uri => "uri",
    :version_id => "versionId",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'cloud_formation/cfn_guard_hook.rb', line 747

def to_jsii
  result = {}
  result.merge!({
    "uri" => @uri,
    "versionId" => @version_id,
  })
  result.compact
end