Class: AWSCDK::FMS::CfnPolicy

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSFMS::IPolicyRef
Defined in:
fms/cfn_policy.rb

Overview

An AWS Firewall Manager policy.

A Firewall Manager policy is specific to the individual policy type. If you want to enforce multiple policy types across accounts, you can create multiple policies. You can create more than one policy for each type.

If you add a new account to an organization that you created with AWS Organizations , Firewall Manager automatically applies the policy to the resources in that account that are within scope of the policy.

Policies require some setup to use. For more information, see the sections on prerequisites and getting started under Firewall Manager prerequisites .

Firewall Manager provides the following types of policies:

  • AWS WAF policy - This policy applies AWS WAF web ACL protections to specified accounts and resources.
  • Shield Advanced policy - This policy applies Shield Advanced protection to specified accounts and resources.
  • Security Groups policy - This type of policy gives you control over security groups that are in use throughout your organization in AWS Organizations and lets you enforce a baseline set of rules across your organization.
  • Network ACL policy - This type of policy gives you control over the network ACLs that are in use throughout your organization in AWS Organizations and lets you enforce a baseline set of first and last network ACL rules across your organization.
  • Network Firewall policy - This policy applies Network Firewall protection to your organization's VPCs.
  • DNS Firewall policy - This policy applies Amazon Route 53 Resolver DNS Firewall protections to your organization's VPCs.
  • Third-party firewall policy - This policy applies third-party firewall protections. Third-party firewalls are available by subscription through the AWS Marketplace console at AWS Marketplace .
  • Palo Alto Networks Cloud NGFW policy - This policy applies Palo Alto Networks Cloud Next Generation Firewall (NGFW) protections and Palo Alto Networks Cloud NGFW rulestacks to your organization's VPCs.
  • Fortigate CNF policy - This policy applies Fortigate Cloud Native Firewall (CNF) protections. Fortigate CNF is a cloud-centered solution that blocks Zero-Day threats and secures cloud infrastructures with industry-leading advanced threat prevention, smart web application firewalls (WAF), and API protection.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnPolicy

Create a new AWS::FMS::Policy.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::FMS::CfnPolicyProps) —

    Resource properties.



36
37
38
39
40
41
42
 
# File 'fms/cfn_policy.rb', line 36

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::FMS::CfnPolicyProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZm1zLkNmblBvbGljeVByb3BzIn0=")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_policy(resource) ⇒ String

Parameters:

Returns:

  • (String) 


105
106
107
108
 
# File 'fms/cfn_policy.rb', line 105

def self.arn_for_policy(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19mbXMuSVBvbGljeVJlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_fms.CfnPolicy", "arnForPolicy", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


212
213
214
 
# File 'fms/cfn_policy.rb', line 212

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_fms.CfnPolicy", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_policy(x) ⇒ Boolean

Checks whether the given object is a CfnPolicy.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


114
115
116
117
 
# File 'fms/cfn_policy.rb', line 114

def self.is_cfn_policy(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_fms.CfnPolicy", "isCfnPolicy", [x])
end

.jsii_overridable_methods ⇒ Object 



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'fms/cfn_policy.rb', line 44

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :policy_ref => { kind: :property, name: "policyRef", is_optional: false },
    :exclude_resource_tags => { kind: :property, name: "excludeResourceTags", is_optional: false },
    :policy_name => { kind: :property, name: "policyName", is_optional: false },
    :remediation_enabled => { kind: :property, name: "remediationEnabled", is_optional: false },
    :security_service_policy_data => { kind: :property, name: "securityServicePolicyData", is_optional: false },
    :delete_all_policy_resources => { kind: :property, name: "deleteAllPolicyResources", is_optional: true },
    :exclude_map => { kind: :property, name: "excludeMap", is_optional: true },
    :include_map => { kind: :property, name: "includeMap", is_optional: true },
    :policy_description => { kind: :property, name: "policyDescription", is_optional: true },
    :resources_clean_up => { kind: :property, name: "resourcesCleanUp", is_optional: true },
    :resource_set_ids => { kind: :property, name: "resourceSetIds", is_optional: true },
    :resource_tag_logical_operator => { kind: :property, name: "resourceTagLogicalOperator", is_optional: true },
    :resource_tags => { kind: :property, name: "resourceTags", is_optional: true },
    :resource_type => { kind: :property, name: "resourceType", is_optional: true },
    :resource_type_list => { kind: :property, name: "resourceTypeList", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



466
467
468
469
 
# File 'fms/cfn_policy.rb', line 466

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



478
479
480
481
 
# File 'fms/cfn_policy.rb', line 478

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



488
489
490
491
 
# File 'fms/cfn_policy.rb', line 488

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



499
500
501
502
503
 
# File 'fms/cfn_policy.rb', line 499

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


556
557
558
559
560
 
# File 'fms/cfn_policy.rb', line 556

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



566
567
568
569
 
# File 'fms/cfn_policy.rb', line 566

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



578
579
580
581
582
 
# File 'fms/cfn_policy.rb', line 578

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



591
592
593
594
 
# File 'fms/cfn_policy.rb', line 591

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



613
614
615
616
617
618
 
# File 'fms/cfn_policy.rb', line 613

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_arn ⇒ String

The Amazon Resource Name (ARN) of the policy.

Returns:

  • (String) 


219
220
221
 
# File 'fms/cfn_policy.rb', line 219

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_id ⇒ String

The ID of the policy.

Returns:

  • (String) 


226
227
228
 
# File 'fms/cfn_policy.rb', line 226

def attr_id()
  jsii_get_property("attrId")
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



233
234
235
 
# File 'fms/cfn_policy.rb', line 233

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



165
166
167
 
# File 'fms/cfn_policy.rb', line 165

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


170
171
172
 
# File 'fms/cfn_policy.rb', line 170

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


622
623
624
625
 
# File 'fms/cfn_policy.rb', line 622

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


175
176
177
 
# File 'fms/cfn_policy.rb', line 175

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


182
183
184
 
# File 'fms/cfn_policy.rb', line 182

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


127
128
129
 
# File 'fms/cfn_policy.rb', line 127

def creation_stack()
  jsii_get_property("creationStack")
end

#delete_all_policy_resources ⇒ Boolean, ...

Used when deleting a policy.

If true , Firewall Manager performs cleanup according to the policy type.

Returns:



298
299
300
 
# File 'fms/cfn_policy.rb', line 298

def delete_all_policy_resources()
  jsii_get_property("deleteAllPolicyResources")
end

#delete_all_policy_resources=(value) ⇒ Object 



302
303
304
305
 
# File 'fms/cfn_policy.rb', line 302

def delete_all_policy_resources=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "deleteAllPolicyResources") unless value.nil?
  jsii_set_property("deleteAllPolicyResources", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



187
188
189
 
# File 'fms/cfn_policy.rb', line 187

def env()
  jsii_get_property("env")
end

#exclude_map ⇒ AWSCDK::IResolvable, ...

Specifies the AWS account IDs and AWS Organizations organizational units (OUs) to exclude from the policy.

Returns:



310
311
312
 
# File 'fms/cfn_policy.rb', line 310

def exclude_map()
  jsii_get_property("excludeMap")
end

#exclude_map=(value) ⇒ Object 



314
315
316
317
318
 
# File 'fms/cfn_policy.rb', line 314

def exclude_map=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::FMS::CfnPolicy::IEMapProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19mbXMuQ2ZuUG9saWN5LklFTWFwUHJvcGVydHkifV19fQ==")), "excludeMap") unless value.nil?
  jsii_set_property("excludeMap", value)
end

#exclude_resource_tags ⇒ Boolean, AWSCDK::IResolvable

Used only when tags are specified in the ResourceTags property.

Returns:



247
248
249
 
# File 'fms/cfn_policy.rb', line 247

def exclude_resource_tags()
  jsii_get_property("excludeResourceTags")
end

#exclude_resource_tags=(value) ⇒ Object 



251
252
253
254
 
# File 'fms/cfn_policy.rb', line 251

def exclude_resource_tags=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "excludeResourceTags")
  jsii_set_property("excludeResourceTags", value)
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



635
636
637
638
639
 
# File 'fms/cfn_policy.rb', line 635

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



646
647
648
649
 
# File 'fms/cfn_policy.rb', line 646

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#include_map ⇒ AWSCDK::IResolvable, ...

Specifies the AWS account IDs and AWS Organizations organizational units (OUs) to include in the policy.

Returns:



323
324
325
 
# File 'fms/cfn_policy.rb', line 323

def include_map()
  jsii_get_property("includeMap")
end

#include_map=(value) ⇒ Object 



327
328
329
330
331
 
# File 'fms/cfn_policy.rb', line 327

def include_map=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::FMS::CfnPolicy::IEMapProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19mbXMuQ2ZuUG9saWN5LklFTWFwUHJvcGVydHkifV19fQ==")), "includeMap") unless value.nil?
  jsii_set_property("includeMap", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



716
717
718
719
 
# File 'fms/cfn_policy.rb', line 716

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


139
140
141
 
# File 'fms/cfn_policy.rb', line 139

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


122
123
124
 
# File 'fms/cfn_policy.rb', line 122

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



657
658
659
 
# File 'fms/cfn_policy.rb', line 657

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



664
665
666
 
# File 'fms/cfn_policy.rb', line 664

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



457
458
459
460
 
# File 'fms/cfn_policy.rb', line 457

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#policy_description ⇒ String?

Your description of the AWS Firewall Manager policy.

Returns:

  • (String, nil) 


336
337
338
 
# File 'fms/cfn_policy.rb', line 336

def policy_description()
  jsii_get_property("policyDescription")
end

#policy_description=(value) ⇒ Object 



340
341
342
343
 
# File 'fms/cfn_policy.rb', line 340

def policy_description=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "policyDescription") unless value.nil?
  jsii_set_property("policyDescription", value)
end

#policy_name ⇒ String

The name of the AWS Firewall Manager policy.

Returns:

  • (String) 


259
260
261
 
# File 'fms/cfn_policy.rb', line 259

def policy_name()
  jsii_get_property("policyName")
end

#policy_name=(value) ⇒ Object 



263
264
265
266
 
# File 'fms/cfn_policy.rb', line 263

def policy_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "policyName")
  jsii_set_property("policyName", value)
end

#policy_ref ⇒ AWSCDK::Interfaces::AWSFMS::PolicyReference

A reference to a Policy resource.

Returns:



240
241
242
 
# File 'fms/cfn_policy.rb', line 240

def policy_ref()
  jsii_get_property("policyRef")
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


158
159
160
 
# File 'fms/cfn_policy.rb', line 158

def ref()
  jsii_get_property("ref")
end

#remediation_enabled ⇒ Boolean, AWSCDK::IResolvable

Indicates if the policy should be automatically applied to new resources.

Returns:



271
272
273
 
# File 'fms/cfn_policy.rb', line 271

def remediation_enabled()
  jsii_get_property("remediationEnabled")
end

#remediation_enabled=(value) ⇒ Object 



275
276
277
278
 
# File 'fms/cfn_policy.rb', line 275

def remediation_enabled=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "remediationEnabled")
  jsii_set_property("remediationEnabled", value)
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



675
676
677
678
 
# File 'fms/cfn_policy.rb', line 675

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


682
683
684
685
 
# File 'fms/cfn_policy.rb', line 682

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



692
693
694
695
696
 
# File 'fms/cfn_policy.rb', line 692

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#resource_set_ids ⇒ Array<String>?

The unique identifiers of the resource sets used by the policy.

Returns:

  • (Array<String>, nil) 


360
361
362
 
# File 'fms/cfn_policy.rb', line 360

def resource_set_ids()
  jsii_get_property("resourceSetIds")
end

#resource_set_ids=(value) ⇒ Object 



364
365
366
367
 
# File 'fms/cfn_policy.rb', line 364

def resource_set_ids=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "resourceSetIds") unless value.nil?
  jsii_set_property("resourceSetIds", value)
end

#resource_tag_logical_operator ⇒ String?

Specifies whether to combine multiple resource tags with AND, so that a resource must have all tags to be included or excluded, or OR, so that a resource must have at least one tag.

Returns:

  • (String, nil) 


372
373
374
 
# File 'fms/cfn_policy.rb', line 372

def resource_tag_logical_operator()
  jsii_get_property("resourceTagLogicalOperator")
end

#resource_tag_logical_operator=(value) ⇒ Object 



376
377
378
379
 
# File 'fms/cfn_policy.rb', line 376

def resource_tag_logical_operator=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "resourceTagLogicalOperator") unless value.nil?
  jsii_set_property("resourceTagLogicalOperator", value)
end

#resource_tags ⇒ AWSCDK::IResolvable, ...

An array of ResourceTag objects, used to explicitly include resources in the policy scope or explicitly exclude them.

Returns:



384
385
386
 
# File 'fms/cfn_policy.rb', line 384

def resource_tags()
  jsii_get_property("resourceTags")
end

#resource_tags=(value) ⇒ Object 



388
389
390
391
 
# File 'fms/cfn_policy.rb', line 388

def resource_tags=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZm1zLkNmblBvbGljeS5SZXNvdXJjZVRhZ1Byb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "resourceTags") unless value.nil?
  jsii_set_property("resourceTags", value)
end

#resource_type ⇒ String?

The type of resource protected by or in scope of the policy.

Returns:

  • (String, nil) 


396
397
398
 
# File 'fms/cfn_policy.rb', line 396

def resource_type()
  jsii_get_property("resourceType")
end

#resource_type=(value) ⇒ Object 



400
401
402
403
 
# File 'fms/cfn_policy.rb', line 400

def resource_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "resourceType") unless value.nil?
  jsii_set_property("resourceType", value)
end

#resource_type_list ⇒ Array<String>?

An array of ResourceType objects.

Returns:

  • (Array<String>, nil) 


408
409
410
 
# File 'fms/cfn_policy.rb', line 408

def resource_type_list()
  jsii_get_property("resourceTypeList")
end

#resource_type_list=(value) ⇒ Object 



412
413
414
415
 
# File 'fms/cfn_policy.rb', line 412

def resource_type_list=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "resourceTypeList") unless value.nil?
  jsii_set_property("resourceTypeList", value)
end

#resources_clean_up ⇒ Boolean, ...

Indicates whether AWS Firewall Manager should automatically remove protections from resources that leave the policy scope and clean up resources that Firewall Manager is managing for accounts when those accounts leave policy scope.

Returns:



348
349
350
 
# File 'fms/cfn_policy.rb', line 348

def resources_clean_up()
  jsii_get_property("resourcesCleanUp")
end

#resources_clean_up=(value) ⇒ Object 



352
353
354
355
 
# File 'fms/cfn_policy.rb', line 352

def resources_clean_up=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "resourcesCleanUp") unless value.nil?
  jsii_set_property("resourcesCleanUp", value)
end

#security_service_policy_data ⇒ AWSCDK::IResolvable, AWSCDK::FMS::CfnPolicy::SecurityServicePolicyDataProperty

Details about the security service that is being used to protect the resources.

Returns:



283
284
285
 
# File 'fms/cfn_policy.rb', line 283

def security_service_policy_data()
  jsii_get_property("securityServicePolicyData")
end

#security_service_policy_data=(value) ⇒ Object 



287
288
289
290
291
 
# File 'fms/cfn_policy.rb', line 287

def security_service_policy_data=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::FMS::CfnPolicy::SecurityServicePolicyDataProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19mbXMuQ2ZuUG9saWN5LlNlY3VyaXR5U2VydmljZVBvbGljeURhdGFQcm9wZXJ0eSJ9XX19")), "securityServicePolicyData")
  jsii_set_property("securityServicePolicyData", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



701
702
703
 
# File 'fms/cfn_policy.rb', line 701

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



148
149
150
 
# File 'fms/cfn_policy.rb', line 148

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Array<AWSCDK::FMS::CfnPolicy::PolicyTagProperty>?

A collection of key:value pairs associated with an AWS resource.

Returns:



420
421
422
 
# File 'fms/cfn_policy.rb', line 420

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



424
425
426
427
428
 
# File 'fms/cfn_policy.rb', line 424

def tags=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::FMS::CfnPolicy::PolicyTagProperty.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19mbXMuQ2ZuUG9saWN5LlBvbGljeVRhZ1Byb3BlcnR5In0sImtpbmQiOiJhcnJheSJ9fQ==")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



433
434
435
 
# File 'fms/cfn_policy.rb', line 433

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


195
196
197
 
# File 'fms/cfn_policy.rb', line 195

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


205
206
207
 
# File 'fms/cfn_policy.rb', line 205

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


707
708
709
710
 
# File 'fms/cfn_policy.rb', line 707

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


446
447
448
449
450
451
 
# File 'fms/cfn_policy.rb', line 446

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end