Class: AWSCDK::EC2::FlowLog

Inherits:
Resource
  • Object
show all
Includes:
IFlowLog
Defined in:
ec2/flow_log.rb

Overview

A VPC flow log.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ FlowLog

Returns a new instance of FlowLog.

Parameters:



12
13
14
15
16
17
18
 
# File 'ec2/flow_log.rb', line 12

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

Class Method Details

.from_flow_log_id(scope, id, flow_log_id) ⇒ AWSCDK::EC2::IFlowLog

Import a Flow Log by it's Id.

Parameters:

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

Returns:



50
51
52
53
54
55
 
# File 'ec2/flow_log.rb', line 50

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.FlowLog", "fromFlowLogId", [scope, id, flow_log_id])
end

.jsii_overridable_methods ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'ec2/flow_log.rb', line 20

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :physical_name => { kind: :property, name: "physicalName", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :flow_log_id => { kind: :property, name: "flowLogId", is_optional: false },
    :flow_log_ref => { kind: :property, name: "flowLogRef", is_optional: false },
    :bucket => { kind: :property, name: "bucket", is_optional: true },
    :delivery_stream => { kind: :property, name: "deliveryStream", is_optional: true },
    :delivery_stream_arn => { kind: :property, name: "deliveryStreamArn", is_optional: true },
    :iam_role => { kind: :property, name: "iamRole", is_optional: true },
    :key_prefix => { kind: :property, name: "keyPrefix", is_optional: true },
    :log_group => { kind: :property, name: "logGroup", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", 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 },
    :generate_physical_name => { kind: :method, name: "generatePhysicalName", is_optional: false },
    :get_resource_arn_attribute => { kind: :method, name: "getResourceArnAttribute", is_optional: false },
    :get_resource_name_attribute => { kind: :method, name: "getResourceNameAttribute", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


103
104
105
 
# File 'ec2/flow_log.rb', line 103

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

Instance Method Details

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters:



197
198
199
200
 
# File 'ec2/flow_log.rb', line 197

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) ⇒ void

This method returns an undefined value.

Apply the given removal policy to this resource.

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

Parameters:



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

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
end

#bucket ⇒ AWSCDK::S3::IBucket?

The S3 bucket to publish flow logs to.

Returns:



124
125
126
 
# File 'ec2/flow_log.rb', line 124

def bucket()
  jsii_get_property("bucket")
end

#delivery_stream ⇒ AWSCDK::Interfaces::AWSKinesisfirehose::IDeliveryStreamRef?

The Amazon Data Firehose delivery stream to publish flow logs to.

Returns:



131
132
133
 
# File 'ec2/flow_log.rb', line 131

def delivery_stream()
  jsii_get_property("deliveryStream")
end

#delivery_stream_arn ⇒ String?

Deprecated.

Use deliveryStream

The ARN of the Amazon Data Firehose delivery stream to publish flow logs to.

Returns:

  • (String, nil) 


139
140
141
 
# File 'ec2/flow_log.rb', line 139

def delivery_stream_arn()
  jsii_get_property("deliveryStreamArn")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Returns:



75
76
77
 
# File 'ec2/flow_log.rb', line 75

def env()
  jsii_get_property("env")
end

#flow_log_id ⇒ String

The Id of the VPC Flow Log.

Returns:

  • (String) 


110
111
112
 
# File 'ec2/flow_log.rb', line 110

def flow_log_id()
  jsii_get_property("flowLogId")
end

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

A reference to a FlowLog resource.

Returns:



117
118
119
 
# File 'ec2/flow_log.rb', line 117

def flow_log_ref()
  jsii_get_property("flowLogRef")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


220
221
222
 
# File 'ec2/flow_log.rb', line 220

def generate_physical_name()
  jsii_call_method("generatePhysicalName", [])
end

#get_resource_arn_attribute(arn_attr, arn_components) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

Normally, this token will resolve to arn_attr, but if the resource is referenced across environments, arn_components will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arn_components.

Parameters:

  • arn_attr (String) —

    The CFN attribute which resolves to the ARN of the resource.

  • arn_components (AWSCDK::ARNComponents) —

    The format of the ARN of this resource.

Returns:

  • (String) 


234
235
236
237
238
239
 
# File 'ec2/flow_log.rb', line 234

def get_resource_arn_attribute(arn_attr, arn_components)
  Jsii::Type.check_type(arn_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arnAttr")
  arn_components = arn_components.is_a?(Hash) ? ::AWSCDK::ARNComponents.new(**arn_components.transform_keys(&:to_sym)) : arn_components
  Jsii::Type.check_type(arn_components, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5Bcm5Db21wb25lbnRzIn0=")), "arnComponents")
  jsii_call_method("getResourceArnAttribute", [arn_attr, arn_components])
end

#get_resource_name_attribute(name_attr) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

Normally, this token will resolve to name_attr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

Parameters:

  • name_attr (String) —

    The CFN attribute which resolves to the resource's name.

Returns:

  • (String) 


249
250
251
252
 
# File 'ec2/flow_log.rb', line 249

def get_resource_name_attribute(name_attr)
  Jsii::Type.check_type(name_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nameAttr")
  jsii_call_method("getResourceNameAttribute", [name_attr])
end

#iam_role ⇒ AWSCDK::IAM::IRole?

The iam role used to publish logs to CloudWatch.

Returns:



146
147
148
 
# File 'ec2/flow_log.rb', line 146

def iam_role()
  jsii_get_property("iamRole")
end

#key_prefix ⇒ String?

S3 bucket key prefix to publish the flow logs under.

Returns:

  • (String, nil) 


153
154
155
 
# File 'ec2/flow_log.rb', line 153

def key_prefix()
  jsii_get_property("keyPrefix")
end

#log_group ⇒ AWSCDK::Logs::ILogGroup?

The CloudWatch Logs LogGroup to publish flow logs to.

Returns:



160
161
162
 
# File 'ec2/flow_log.rb', line 160

def log_group()
  jsii_get_property("logGroup")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


60
61
62
 
# File 'ec2/flow_log.rb', line 60

def node()
  jsii_get_property("node")
end

#physical_name ⇒ String

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

  • a concrete value (e.g. "my-awesome-bucket")
  • undefined, when a name should be generated by CloudFormation
  • a concrete name generated automatically during synthesis, in cross-environment scenarios.

Returns:

  • (String) 


89
90
91
 
# File 'ec2/flow_log.rb', line 89

def physical_name()
  jsii_get_property("physicalName")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



96
97
98
 
# File 'ec2/flow_log.rb', line 96

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


167
168
169
 
# File 'ec2/flow_log.rb', line 167

def to_string()
  jsii_call_method("toString", [])
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) 


180
181
182
183
184
185
 
# File 'ec2/flow_log.rb', line 180

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