Class: AWSCDK::EC2::CfnTrafficMirrorTarget
- Inherits:
-
CfnResource
- Object
- CfnResource
- AWSCDK::EC2::CfnTrafficMirrorTarget
- Includes:
- IInspectable, ITaggable, Interfaces::AWSEC2::ITrafficMirrorTargetRef
- Defined in:
- ec2/cfn_traffic_mirror_target.rb
Overview
Specifies a target for your Traffic Mirror session.
A Traffic Mirror target is the destination for mirrored traffic. The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in different VPCs connected via VPC peering or a transit gateway.
A Traffic Mirror target can be a network interface, a Network Load Balancer, or a Gateway Load Balancer endpoint.
To use the target in a Traffic Mirror session, use AWS::EC2::TrafficMirrorSession .
Class Method Summary collapse
- .arn_for_traffic_mirror_target(resource) ⇒ String
-
.CFN_RESOURCE_TYPE_NAME ⇒ String
The CloudFormation resource type name for this resource class.
-
.from_traffic_mirror_target_id(scope, id, traffic_mirror_target_id) ⇒ AWSCDK::Interfaces::AWSEC2::ITrafficMirrorTargetRef
Creates a new ITrafficMirrorTargetRef from a trafficMirrorTargetId.
-
.is_cfn_traffic_mirror_target(x) ⇒ Boolean
Checks whether the given object is a CfnTrafficMirrorTarget.
- .jsii_overridable_methods ⇒ Object
Instance Method Summary collapse
-
#add_deletion_override(path) ⇒ void
Syntactic sugar for
addOverride(path, undefined). -
#add_dependency(target) ⇒ void
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
-
#add_depends_on(target) ⇒ void
deprecated
Deprecated.
use addDependency
-
#add_metadata(key, value) ⇒ void
Add a value to the CloudFormation Resource Metadata.
-
#add_override(path, value) ⇒ void
Adds an override to the synthesized CloudFormation resource.
-
#add_property_deletion_override(property_path) ⇒ void
Adds an override that deletes the value of a property from the resource definition.
-
#add_property_override(property_path, value) ⇒ void
Adds an override to a resource property.
-
#apply_cross_stack_reference_strength(strength) ⇒ void
Sets the cross-stack reference strength for this resource.
-
#apply_removal_policy(policy = nil, options = nil) ⇒ void
Sets the deletion policy of the resource based on the removal policy specified.
- #attr_id ⇒ String
-
#cfn_options ⇒ AWSCDK::ICfnResourceOptions
Options for this resource, such as condition, update policy etc.
- #cfn_properties ⇒ Hash{String => Object}
- #cfn_property_name(cdk_property_name) ⇒ String?
- #cfn_property_names ⇒ Hash{String => String}
-
#cfn_resource_type ⇒ String
AWS resource type.
- #creation_stack ⇒ Array<String>
-
#description ⇒ String?
The description of the Traffic Mirror target.
- #description=(value) ⇒ Object
- #env ⇒ AWSCDK::Interfaces::ResourceEnvironment
-
#gateway_load_balancer_endpoint_id ⇒ String?
The ID of the Gateway Load Balancer endpoint.
- #gateway_load_balancer_endpoint_id=(value) ⇒ Object
-
#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference
Returns a token for an runtime attribute of this resource.
-
#get_metadata(key) ⇒ Object
Retrieve a value value from the CloudFormation Resource Metadata.
-
#initialize(scope, id, props = nil) ⇒ CfnTrafficMirrorTarget
constructor
Create a new
AWS::EC2::TrafficMirrorTarget. -
#inspect(inspector) ⇒ void
Examines the CloudFormation resource and discloses attributes.
-
#logical_id ⇒ String
The logical ID for this CloudFormation stack element.
-
#network_interface_id ⇒ String?
The network interface ID that is associated with the target.
- #network_interface_id=(value) ⇒ Object
-
#network_load_balancer_arn ⇒ String?
The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the target.
- #network_load_balancer_arn=(value) ⇒ Object
-
#node ⇒ Constructs::Node
The tree node.
-
#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>
Retrieves an array of resources this resource depends on.
-
#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>
Get a shallow copy of dependencies between this resource and other resources in the same stack.
-
#override_logical_id(new_logical_id) ⇒ void
Overrides the auto-generated logical ID with a specific ID.
-
#ref ⇒ String
Return a string that will be resolved to a CloudFormation
{ Ref }for this element. -
#remove_dependency(target) ⇒ void
Indicates that this resource no longer depends on another resource.
- #render_properties(props) ⇒ Hash{String => Object}
-
#replace_dependency(target, new_target) ⇒ void
Replaces one dependency with another.
-
#should_synthesize ⇒ Boolean
Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
-
#stack ⇒ AWSCDK::Stack
The stack in which this element is defined.
-
#tags ⇒ AWSCDK::TagManager
Tag Manager which manages the tags for this resource.
-
#tags_raw ⇒ Array<AWSCDK::CfnTag>?
The tags to assign to the Traffic Mirror target.
- #tags_raw=(value) ⇒ Object
-
#to_string ⇒ String
Returns a string representation of this construct.
-
#traffic_mirror_target_ref ⇒ AWSCDK::Interfaces::AWSEC2::TrafficMirrorTargetReference
A reference to a TrafficMirrorTarget resource.
-
#updated_properites ⇒ Hash{String => Object}
deprecated
Deprecated.
use
updatedPropertiesReturn properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource. -
#updated_properties ⇒ Hash{String => Object}
Return properties modified after initiation.
- #validate_properties(_properties) ⇒ void
-
#with(*mixins) ⇒ Constructs::IConstruct
Applies one or more mixins to this construct.
Constructor Details
#initialize(scope, id, props = nil) ⇒ CfnTrafficMirrorTarget
Create a new AWS::EC2::TrafficMirrorTarget.
24 25 26 27 28 29 30 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 24 def initialize(scope, id, props = nil) props = props.is_a?(Hash) ? ::AWSCDK::EC2::CfnTrafficMirrorTargetProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkNmblRyYWZmaWNNaXJyb3JUYXJnZXRQcm9wcyJ9")), "props") unless props.nil? Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props) end |
Class Method Details
.arn_for_traffic_mirror_target(resource) ⇒ String
82 83 84 85 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 82 def self.arn_for_traffic_mirror_target(resource) Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19lYzIuSVRyYWZmaWNNaXJyb3JUYXJnZXRSZWYifQ==")), "resource") Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnTrafficMirrorTarget", "arnForTrafficMirrorTarget", [resource]) end |
.CFN_RESOURCE_TYPE_NAME ⇒ String
The CloudFormation resource type name for this resource class.
202 203 204 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 202 def self.CFN_RESOURCE_TYPE_NAME() Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ec2.CfnTrafficMirrorTarget", "CFN_RESOURCE_TYPE_NAME") end |
.from_traffic_mirror_target_id(scope, id, traffic_mirror_target_id) ⇒ AWSCDK::Interfaces::AWSEC2::ITrafficMirrorTargetRef
Creates a new ITrafficMirrorTargetRef from a trafficMirrorTargetId.
93 94 95 96 97 98 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 93 def self.from_traffic_mirror_target_id(scope, id, traffic_mirror_target_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(traffic_mirror_target_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "trafficMirrorTargetId") Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnTrafficMirrorTarget", "fromTrafficMirrorTargetId", [scope, id, traffic_mirror_target_id]) end |
.is_cfn_traffic_mirror_target(x) ⇒ Boolean
Checks whether the given object is a CfnTrafficMirrorTarget.
104 105 106 107 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 104 def self.is_cfn_traffic_mirror_target(x) Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x") Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnTrafficMirrorTarget", "isCfnTrafficMirrorTarget", [x]) end |
.jsii_overridable_methods ⇒ Object
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 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 32 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 }, :tags => { kind: :property, name: "tags", is_optional: false }, :traffic_mirror_target_ref => { kind: :property, name: "trafficMirrorTargetRef", is_optional: false }, :description => { kind: :property, name: "description", is_optional: true }, :gateway_load_balancer_endpoint_id => { kind: :property, name: "gatewayLoadBalancerEndpointId", is_optional: true }, :network_interface_id => { kind: :property, name: "networkInterfaceId", is_optional: true }, :network_load_balancer_arn => { kind: :property, name: "networkLoadBalancerArn", is_optional: true }, :tags_raw => { kind: :property, name: "tagsRaw", 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).
322 323 324 325 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 322 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.
334 335 336 337 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 334 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
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.
344 345 346 347 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 344 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.
355 356 357 358 359 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 355 def (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.
412 413 414 415 416 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 412 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.
422 423 424 425 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 422 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).
434 435 436 437 438 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 434 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.
447 448 449 450 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 447 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:
469 470 471 472 473 474 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 469 def apply_removal_policy(policy = nil, = nil) Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil? = .is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**.transform_keys(&:to_sym)) : Jsii::Type.check_type(, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless .nil? jsii_call_method("applyRemovalPolicy", [policy, ]) end |
#attr_id ⇒ String
207 208 209 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 207 def attr_id() jsii_get_property("attrId") end |
#cfn_options ⇒ AWSCDK::ICfnResourceOptions
Options for this resource, such as condition, update policy etc.
155 156 157 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 155 def () jsii_get_property("cfnOptions") end |
#cfn_properties ⇒ Hash{String => Object}
160 161 162 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 160 def cfn_properties() jsii_get_property("cfnProperties") end |
#cfn_property_name(cdk_property_name) ⇒ String?
478 479 480 481 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 478 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}
165 166 167 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 165 def cfn_property_names() jsii_get_property("cfnPropertyNames") end |
#cfn_resource_type ⇒ String
AWS resource type.
172 173 174 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 172 def cfn_resource_type() jsii_get_property("cfnResourceType") end |
#creation_stack ⇒ Array<String>
117 118 119 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 117 def creation_stack() jsii_get_property("creationStack") end |
#description ⇒ String?
The description of the Traffic Mirror target.
228 229 230 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 228 def description() jsii_get_property("description") end |
#description=(value) ⇒ Object
232 233 234 235 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 232 def description=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless value.nil? jsii_set_property("description", value) end |
#env ⇒ AWSCDK::Interfaces::ResourceEnvironment
177 178 179 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 177 def env() jsii_get_property("env") end |
#gateway_load_balancer_endpoint_id ⇒ String?
The ID of the Gateway Load Balancer endpoint.
240 241 242 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 240 def gateway_load_balancer_endpoint_id() jsii_get_property("gatewayLoadBalancerEndpointId") end |
#gateway_load_balancer_endpoint_id=(value) ⇒ Object
244 245 246 247 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 244 def gateway_load_balancer_endpoint_id=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "gatewayLoadBalancerEndpointId") unless value.nil? jsii_set_property("gatewayLoadBalancerEndpointId", 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.
491 492 493 494 495 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 491 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.
502 503 504 505 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 502 def (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.
572 573 574 575 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 572 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).
129 130 131 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 129 def logical_id() jsii_get_property("logicalId") end |
#network_interface_id ⇒ String?
The network interface ID that is associated with the target.
252 253 254 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 252 def network_interface_id() jsii_get_property("networkInterfaceId") end |
#network_interface_id=(value) ⇒ Object
256 257 258 259 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 256 def network_interface_id=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "networkInterfaceId") unless value.nil? jsii_set_property("networkInterfaceId", value) end |
#network_load_balancer_arn ⇒ String?
The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the target.
264 265 266 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 264 def network_load_balancer_arn() jsii_get_property("networkLoadBalancerArn") end |
#network_load_balancer_arn=(value) ⇒ Object
268 269 270 271 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 268 def network_load_balancer_arn=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "networkLoadBalancerArn") unless value.nil? jsii_set_property("networkLoadBalancerArn", value) end |
#node ⇒ Constructs::Node
The tree node.
112 113 114 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 112 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.
513 514 515 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 513 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.
520 521 522 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 520 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.
313 314 315 316 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 313 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 }).
148 149 150 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 148 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.
531 532 533 534 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 531 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}
538 539 540 541 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 538 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.
548 549 550 551 552 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 548 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 |
#should_synthesize ⇒ Boolean
Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
557 558 559 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 557 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).
138 139 140 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 138 def stack() jsii_get_property("stack") end |
#tags ⇒ AWSCDK::TagManager
Tag Manager which manages the tags for this resource.
214 215 216 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 214 def () jsii_get_property("tags") end |
#tags_raw ⇒ Array<AWSCDK::CfnTag>?
The tags to assign to the Traffic Mirror target.
276 277 278 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 276 def () jsii_get_property("tagsRaw") end |
#tags_raw=(value) ⇒ Object
280 281 282 283 284 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 280 def (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.
289 290 291 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 289 def to_string() jsii_call_method("toString", []) end |
#traffic_mirror_target_ref ⇒ AWSCDK::Interfaces::AWSEC2::TrafficMirrorTargetReference
A reference to a TrafficMirrorTarget resource.
221 222 223 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 221 def traffic_mirror_target_ref() jsii_get_property("trafficMirrorTargetRef") end |
#updated_properites ⇒ Hash{String => Object}
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.
185 186 187 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 185 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.
195 196 197 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 195 def updated_properties() jsii_get_property("updatedProperties") end |
#validate_properties(_properties) ⇒ void
This method returns an undefined value.
563 564 565 566 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 563 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.
302 303 304 305 306 307 |
# File 'ec2/cfn_traffic_mirror_target.rb', line 302 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 |