Class: AWSCDK::XRay::CfnResourcePolicyProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
x_ray/cfn_resource_policy_props.rb

Overview

Properties for defining a CfnResourcePolicy.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(policy_document:, policy_name:, bypass_policy_lockout_check: nil) ⇒ CfnResourcePolicyProps

Returns a new instance of CfnResourcePolicyProps.

Parameters:

  • policy_document (String) —

    The resource-based policy document, which can be up to 5kb in size.

  • policy_name (String) —

    The name of the resource-based policy.

  • bypass_policy_lockout_check (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    A flag to indicate whether to bypass the resource-based policy lockout safety check.



12
13
14
15
16
17
18
19
 
# File 'x_ray/cfn_resource_policy_props.rb', line 12

def initialize(policy_document:, policy_name:, bypass_policy_lockout_check: nil)
  @policy_document = policy_document
  Jsii::Type.check_type(@policy_document, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "policyDocument")
  @policy_name = policy_name
  Jsii::Type.check_type(@policy_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "policyName")
  @bypass_policy_lockout_check = bypass_policy_lockout_check
  Jsii::Type.check_type(@bypass_policy_lockout_check, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "bypassPolicyLockoutCheck") unless @bypass_policy_lockout_check.nil?
end

Instance Attribute Details

#bypass_policy_lockout_check ⇒ Boolean, ... (readonly)

A flag to indicate whether to bypass the resource-based policy lockout safety check.

Returns:

See Also:



37
38
39
 
# File 'x_ray/cfn_resource_policy_props.rb', line 37

def bypass_policy_lockout_check
  @bypass_policy_lockout_check
end

#policy_document ⇒ String (readonly)

The resource-based policy document, which can be up to 5kb in size.

Returns:

  • (String)

See Also:



25
26
27
 
# File 'x_ray/cfn_resource_policy_props.rb', line 25

def policy_document
  @policy_document
end

#policy_name ⇒ String (readonly)

The name of the resource-based policy.

Must be unique within a specific AWS account.

Returns:

  • (String)

See Also:



32
33
34
 
# File 'x_ray/cfn_resource_policy_props.rb', line 32

def policy_name
  @policy_name
end

Class Method Details

.jsii_properties ⇒ Object 



39
40
41
42
43
44
45
 
# File 'x_ray/cfn_resource_policy_props.rb', line 39

def self.jsii_properties
  {
    :policy_document => "policyDocument",
    :policy_name => "policyName",
    :bypass_policy_lockout_check => "bypassPolicyLockoutCheck",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



47
48
49
50
51
52
53
54
55
 
# File 'x_ray/cfn_resource_policy_props.rb', line 47

def to_jsii
  result = {}
  result.merge!({
    "policyDocument" => @policy_document,
    "policyName" => @policy_name,
    "bypassPolicyLockoutCheck" => @bypass_policy_lockout_check,
  })
  result.compact
end