Class: AWSCDK::EC2::CfnFlowLog

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSEC2::IFlowLogRef
Defined in:
ec2/cfn_flow_log.rb

Overview

Specifies a VPC flow log that captures IP traffic for a specified network interface, subnet, or VPC.

To view the log data, use Amazon CloudWatch Logs (CloudWatch Logs) to help troubleshoot connection issues. For example, you can use a flow log to investigate why certain traffic isn't reaching an instance, which can help you diagnose overly restrictive security group rules. For more information, see VPC Flow Logs in the Amazon VPC User Guide .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnFlowLog

Create a new AWS::EC2::FlowLog.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::EC2::CfnFlowLogProps) —

    Resource properties.



20
21
22
23
24
25
26
 
# File 'ec2/cfn_flow_log.rb', line 20

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::EC2::CfnFlowLogProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkNmbkZsb3dMb2dQcm9wcyJ9")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_flow_log(resource) ⇒ String

Parameters:

Returns:

  • (String) 


86
87
88
89
 
# File 'ec2/cfn_flow_log.rb', line 86

def self.arn_for_flow_log(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19lYzIuSUZsb3dMb2dSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnFlowLog", "arnForFlowLog", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


206
207
208
 
# File 'ec2/cfn_flow_log.rb', line 206

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

.from_flow_log_id(scope, id, flow_log_id) ⇒ AWSCDK::Interfaces::AWSEC2::IFlowLogRef

Creates a new IFlowLogRef from a flowLogId.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • flow_log_id (String)

Returns:



97
98
99
100
101
102
 
# File 'ec2/cfn_flow_log.rb', line 97

def self.from_flow_log_id(scope, id, flow_log_id)
  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(flow_log_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "flowLogId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnFlowLog", "fromFlowLogId", [scope, id, flow_log_id])
end

.is_cfn_flow_log(x) ⇒ Boolean

Checks whether the given object is a CfnFlowLog.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


108
109
110
111
 
# File 'ec2/cfn_flow_log.rb', line 108

def self.is_cfn_flow_log(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnFlowLog", "isCfnFlowLog", [x])
end

.jsii_overridable_methods ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
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
 
# File 'ec2/cfn_flow_log.rb', line 28

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_id => { kind: :property, name: "attrId", is_optional: false },
    :flow_log_ref => { kind: :property, name: "flowLogRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :destination_options => { kind: :property, name: "destinationOptions", is_optional: false },
    :resource_id => { kind: :property, name: "resourceId", is_optional: false },
    :resource_type => { kind: :property, name: "resourceType", is_optional: false },
    :deliver_cross_account_role => { kind: :property, name: "deliverCrossAccountRole", is_optional: true },
    :deliver_logs_permission_arn => { kind: :property, name: "deliverLogsPermissionArn", is_optional: true },
    :log_destination => { kind: :property, name: "logDestination", is_optional: true },
    :log_destination_type => { kind: :property, name: "logDestinationType", is_optional: true },
    :log_format => { kind: :property, name: "logFormat", is_optional: true },
    :log_group_name => { kind: :property, name: "logGroupName", is_optional: true },
    :max_aggregation_interval => { kind: :property, name: "maxAggregationInterval", is_optional: true },
    :tag_field_specifications => { kind: :property, name: "tagFieldSpecifications", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :traffic_type => { kind: :property, name: "trafficType", 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.



428
429
430
431
 
# File 'ec2/cfn_flow_log.rb', line 428

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:



440
441
442
443
 
# File 'ec2/cfn_flow_log.rb', line 440

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:



450
451
452
453
 
# File 'ec2/cfn_flow_log.rb', line 450

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:



461
462
463
464
465
 
# File 'ec2/cfn_flow_log.rb', line 461

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.


518
519
520
521
522
 
# File 'ec2/cfn_flow_log.rb', line 518

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.



528
529
530
531
 
# File 'ec2/cfn_flow_log.rb', line 528

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.



540
541
542
543
544
 
# File 'ec2/cfn_flow_log.rb', line 540

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:



553
554
555
556
 
# File 'ec2/cfn_flow_log.rb', line 553

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:



575
576
577
578
579
580
 
# File 'ec2/cfn_flow_log.rb', line 575

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_id ⇒ String

The ID of the flow log.

For example, fl-123456abc123abc1 .

Returns:

  • (String) 


215
216
217
 
# File 'ec2/cfn_flow_log.rb', line 215

def attr_id()
  jsii_get_property("attrId")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



159
160
161
 
# File 'ec2/cfn_flow_log.rb', line 159

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


164
165
166
 
# File 'ec2/cfn_flow_log.rb', line 164

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


584
585
586
587
 
# File 'ec2/cfn_flow_log.rb', line 584

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}) 


169
170
171
 
# File 'ec2/cfn_flow_log.rb', line 169

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


176
177
178
 
# File 'ec2/cfn_flow_log.rb', line 176

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


121
122
123
 
# File 'ec2/cfn_flow_log.rb', line 121

def creation_stack()
  jsii_get_property("creationStack")
end

#deliver_cross_account_role ⇒ String?

The ARN of the IAM role that allows the service to publish flow logs across accounts.

Returns:

  • (String, nil) 


272
273
274
 
# File 'ec2/cfn_flow_log.rb', line 272

def ()
  jsii_get_property("deliverCrossAccountRole")
end

#deliver_cross_account_role=(value) ⇒ Object 



276
277
278
279
 
# File 'ec2/cfn_flow_log.rb', line 276

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

#deliver_logs_permission_arn ⇒ String?

The ARN of the IAM role that allows Amazon EC2 to publish flow logs to the log destination.

Returns:

  • (String, nil) 


284
285
286
 
# File 'ec2/cfn_flow_log.rb', line 284

def deliver_logs_permission_arn()
  jsii_get_property("deliverLogsPermissionArn")
end

#deliver_logs_permission_arn=(value) ⇒ Object 



288
289
290
291
 
# File 'ec2/cfn_flow_log.rb', line 288

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

#destination_options ⇒ Object

The destination options.

Returns:

  • (Object) 


236
237
238
 
# File 'ec2/cfn_flow_log.rb', line 236

def destination_options()
  jsii_get_property("destinationOptions")
end

#destination_options=(value) ⇒ Object 



240
241
242
243
 
# File 'ec2/cfn_flow_log.rb', line 240

def destination_options=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "destinationOptions")
  jsii_set_property("destinationOptions", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



181
182
183
 
# File 'ec2/cfn_flow_log.rb', line 181

def env()
  jsii_get_property("env")
end

#flow_log_ref ⇒ AWSCDK::Interfaces::AWSEC2::FlowLogReference

A reference to a FlowLog resource.

Returns:



222
223
224
 
# File 'ec2/cfn_flow_log.rb', line 222

def flow_log_ref()
  jsii_get_property("flowLogRef")
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:



597
598
599
600
601
 
# File 'ec2/cfn_flow_log.rb', line 597

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:



608
609
610
611
 
# File 'ec2/cfn_flow_log.rb', line 608

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



678
679
680
681
 
# File 'ec2/cfn_flow_log.rb', line 678

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

#log_destination ⇒ String?

The destination for the flow log data.

The meaning of this parameter depends on the destination type.

Returns:

  • (String, nil) 


298
299
300
 
# File 'ec2/cfn_flow_log.rb', line 298

def log_destination()
  jsii_get_property("logDestination")
end

#log_destination=(value) ⇒ Object 



302
303
304
305
 
# File 'ec2/cfn_flow_log.rb', line 302

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

#log_destination_type ⇒ String?

The type of destination for the flow log data.

Returns:

  • (String, nil) 


310
311
312
 
# File 'ec2/cfn_flow_log.rb', line 310

def log_destination_type()
  jsii_get_property("logDestinationType")
end

#log_destination_type=(value) ⇒ Object 



314
315
316
317
 
# File 'ec2/cfn_flow_log.rb', line 314

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

#log_format ⇒ String?

The fields to include in the flow log record, in the order in which they should appear.

Returns:

  • (String, nil) 


322
323
324
 
# File 'ec2/cfn_flow_log.rb', line 322

def log_format()
  jsii_get_property("logFormat")
end

#log_format=(value) ⇒ Object 



326
327
328
329
 
# File 'ec2/cfn_flow_log.rb', line 326

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

#log_group_name ⇒ String?

The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.

Returns:

  • (String, nil) 


334
335
336
 
# File 'ec2/cfn_flow_log.rb', line 334

def log_group_name()
  jsii_get_property("logGroupName")
end

#log_group_name=(value) ⇒ Object 



338
339
340
341
 
# File 'ec2/cfn_flow_log.rb', line 338

def log_group_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "logGroupName") unless value.nil?
  jsii_set_property("logGroupName", value)
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) 


133
134
135
 
# File 'ec2/cfn_flow_log.rb', line 133

def logical_id()
  jsii_get_property("logicalId")
end

#max_aggregation_interval ⇒ Numeric?

The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record.

Returns:

  • (Numeric, nil) 


346
347
348
 
# File 'ec2/cfn_flow_log.rb', line 346

def max_aggregation_interval()
  jsii_get_property("maxAggregationInterval")
end

#max_aggregation_interval=(value) ⇒ Object 



350
351
352
353
 
# File 'ec2/cfn_flow_log.rb', line 350

def max_aggregation_interval=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxAggregationInterval") unless value.nil?
  jsii_set_property("maxAggregationInterval", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


116
117
118
 
# File 'ec2/cfn_flow_log.rb', line 116

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:



619
620
621
 
# File 'ec2/cfn_flow_log.rb', line 619

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:



626
627
628
 
# File 'ec2/cfn_flow_log.rb', line 626

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.



419
420
421
422
 
# File 'ec2/cfn_flow_log.rb', line 419

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

#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) 


152
153
154
 
# File 'ec2/cfn_flow_log.rb', line 152

def ref()
  jsii_get_property("ref")
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:



637
638
639
640
 
# File 'ec2/cfn_flow_log.rb', line 637

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}) 


644
645
646
647
 
# File 'ec2/cfn_flow_log.rb', line 644

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:



654
655
656
657
658
 
# File 'ec2/cfn_flow_log.rb', line 654

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_id ⇒ String

The ID of the resource to monitor.

Returns:

  • (String) 


248
249
250
 
# File 'ec2/cfn_flow_log.rb', line 248

def resource_id()
  jsii_get_property("resourceId")
end

#resource_id=(value) ⇒ Object 



252
253
254
255
 
# File 'ec2/cfn_flow_log.rb', line 252

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

#resource_type ⇒ String

The type of resource to monitor.

Returns:

  • (String) 


260
261
262
 
# File 'ec2/cfn_flow_log.rb', line 260

def resource_type()
  jsii_get_property("resourceType")
end

#resource_type=(value) ⇒ Object 



264
265
266
267
 
# File 'ec2/cfn_flow_log.rb', line 264

def resource_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "resourceType")
  jsii_set_property("resourceType", 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.



663
664
665
 
# File 'ec2/cfn_flow_log.rb', line 663

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:



142
143
144
 
# File 'ec2/cfn_flow_log.rb', line 142

def stack()
  jsii_get_property("stack")
end

#tag_field_specifications ⇒ AWSCDK::IResolvable, ...

The resource types and associated tags for EC2 resources associated with the EC2 Tags feature for log enrichment.

Returns:



358
359
360
 
# File 'ec2/cfn_flow_log.rb', line 358

def tag_field_specifications()
  jsii_get_property("tagFieldSpecifications")
end

#tag_field_specifications=(value) ⇒ Object 



362
363
364
365
 
# File 'ec2/cfn_flow_log.rb', line 362

def tag_field_specifications=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkNmbkZsb3dMb2cuVGFnRmllbGRTcGVjaWZpY2F0aW9uUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "tagFieldSpecifications") unless value.nil?
  jsii_set_property("tagFieldSpecifications", value)
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



229
230
231
 
# File 'ec2/cfn_flow_log.rb', line 229

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

The tags to apply to the flow logs.

Returns:



370
371
372
 
# File 'ec2/cfn_flow_log.rb', line 370

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



374
375
376
377
378
 
# File 'ec2/cfn_flow_log.rb', line 374

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



395
396
397
 
# File 'ec2/cfn_flow_log.rb', line 395

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

#traffic_type ⇒ String?

The type of traffic to monitor (accepted traffic, rejected traffic, or all traffic).

Returns:

  • (String, nil) 


383
384
385
 
# File 'ec2/cfn_flow_log.rb', line 383

def traffic_type()
  jsii_get_property("trafficType")
end

#traffic_type=(value) ⇒ Object 



387
388
389
390
 
# File 'ec2/cfn_flow_log.rb', line 387

def traffic_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "trafficType") unless value.nil?
  jsii_set_property("trafficType", value)
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}) 


189
190
191
 
# File 'ec2/cfn_flow_log.rb', line 189

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}) 


199
200
201
 
# File 'ec2/cfn_flow_log.rb', line 199

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


669
670
671
672
 
# File 'ec2/cfn_flow_log.rb', line 669

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) 


408
409
410
411
412
413
 
# File 'ec2/cfn_flow_log.rb', line 408

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