Class: AWSCDK::MSK::CfnVPCConnection
- Inherits:
-
CfnResource
- Object
- CfnResource
- AWSCDK::MSK::CfnVPCConnection
- Includes:
- IInspectable, ITaggable, Interfaces::AWSMSK::IVPCConnectionRef
- Defined in:
- msk/cfn_vpc_connection.rb
Overview
Create remote VPC connection.
Class Method Summary collapse
- .arn_for_vpc_connection(resource) ⇒ String
-
.CFN_RESOURCE_TYPE_NAME ⇒ String
The CloudFormation resource type name for this resource class.
-
.is_cfn_vpc_connection(x) ⇒ Boolean
Checks whether the given object is a CfnVpcConnection.
- .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_arn ⇒ String
The ARN of the VPC connection.
-
#authentication ⇒ String
The type of private link authentication.
- #authentication=(value) ⇒ Object
-
#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.
-
#client_subnets ⇒ Array<String>
The list of subnets in the client VPC to connect to.
- #client_subnets=(value) ⇒ Object
- #creation_stack ⇒ Array<String>
- #env ⇒ AWSCDK::Interfaces::ResourceEnvironment
-
#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) ⇒ CfnVPCConnection
constructor
Create a new
AWS::MSK::VpcConnection. -
#inspect(inspector) ⇒ void
Examines the CloudFormation resource and discloses attributes.
-
#logical_id ⇒ String
The logical ID for this CloudFormation stack element.
-
#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.
-
#security_groups ⇒ Array<String>
The security groups to attach to the ENIs for the broker nodes.
- #security_groups=(value) ⇒ Object
-
#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 ⇒ Hash{String => String}?
An arbitrary set of tags (key-value pairs) you specify while creating the VPC connection.
- #tags_raw=(value) ⇒ Object
-
#target_cluster_arn ⇒ String
The Amazon Resource Name (ARN) of the cluster.
- #target_cluster_arn=(value) ⇒ Object
-
#to_string ⇒ String
Returns a string representation of this construct.
-
#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
-
#vpc_connection_ref ⇒ AWSCDK::Interfaces::AWSMSK::VPCConnectionReference
A reference to a VpcConnection resource.
-
#vpc_id ⇒ String
The VPC ID of the remote client.
- #vpc_id=(value) ⇒ Object
-
#with(*mixins) ⇒ Constructs::IConstruct
Applies one or more mixins to this construct.
Constructor Details
#initialize(scope, id, props) ⇒ CfnVPCConnection
Create a new AWS::MSK::VpcConnection.
18 19 20 21 22 23 24 |
# File 'msk/cfn_vpc_connection.rb', line 18 def initialize(scope, id, props) props = props.is_a?(Hash) ? ::AWSCDK::MSK::CfnVPCConnectionProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbXNrLkNmblZwY0Nvbm5lY3Rpb25Qcm9wcyJ9")), "props") Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props) end |
Class Method Details
.arn_for_vpc_connection(resource) ⇒ String
77 78 79 80 |
# File 'msk/cfn_vpc_connection.rb', line 77 def self.arn_for_vpc_connection(resource) Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19tc2suSVZwY0Nvbm5lY3Rpb25SZWYifQ==")), "resource") Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_msk.CfnVpcConnection", "arnForVpcConnection", [resource]) end |
.CFN_RESOURCE_TYPE_NAME ⇒ String
The CloudFormation resource type name for this resource class.
184 185 186 |
# File 'msk/cfn_vpc_connection.rb', line 184 def self.CFN_RESOURCE_TYPE_NAME() Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_msk.CfnVpcConnection", "CFN_RESOURCE_TYPE_NAME") end |
.is_cfn_vpc_connection(x) ⇒ Boolean
Checks whether the given object is a CfnVpcConnection.
86 87 88 89 |
# File 'msk/cfn_vpc_connection.rb', line 86 def self.is_cfn_vpc_connection(x) Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x") Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_msk.CfnVpcConnection", "isCfnVpcConnection", [x]) end |
.jsii_overridable_methods ⇒ Object
26 27 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 |
# File 'msk/cfn_vpc_connection.rb', line 26 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 }, :tags => { kind: :property, name: "tags", is_optional: false }, :vpc_connection_ref => { kind: :property, name: "vpcConnectionRef", is_optional: false }, :authentication => { kind: :property, name: "authentication", is_optional: false }, :client_subnets => { kind: :property, name: "clientSubnets", is_optional: false }, :security_groups => { kind: :property, name: "securityGroups", is_optional: false }, :target_cluster_arn => { kind: :property, name: "targetClusterArn", is_optional: false }, :vpc_id => { kind: :property, name: "vpcId", is_optional: false }, :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).
317 318 319 320 |
# File 'msk/cfn_vpc_connection.rb', line 317 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.
329 330 331 332 |
# File 'msk/cfn_vpc_connection.rb', line 329 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.
339 340 341 342 |
# File 'msk/cfn_vpc_connection.rb', line 339 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.
350 351 352 353 354 |
# File 'msk/cfn_vpc_connection.rb', line 350 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.
407 408 409 410 411 |
# File 'msk/cfn_vpc_connection.rb', line 407 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.
417 418 419 420 |
# File 'msk/cfn_vpc_connection.rb', line 417 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).
429 430 431 432 433 |
# File 'msk/cfn_vpc_connection.rb', line 429 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.
442 443 444 445 |
# File 'msk/cfn_vpc_connection.rb', line 442 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:
464 465 466 467 468 469 |
# File 'msk/cfn_vpc_connection.rb', line 464 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_arn ⇒ String
The ARN of the VPC connection.
191 192 193 |
# File 'msk/cfn_vpc_connection.rb', line 191 def attr_arn() jsii_get_property("attrArn") end |
#authentication ⇒ String
The type of private link authentication.
212 213 214 |
# File 'msk/cfn_vpc_connection.rb', line 212 def authentication() jsii_get_property("authentication") end |
#authentication=(value) ⇒ Object
216 217 218 219 |
# File 'msk/cfn_vpc_connection.rb', line 216 def authentication=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "authentication") jsii_set_property("authentication", value) end |
#cfn_options ⇒ AWSCDK::ICfnResourceOptions
Options for this resource, such as condition, update policy etc.
137 138 139 |
# File 'msk/cfn_vpc_connection.rb', line 137 def () jsii_get_property("cfnOptions") end |
#cfn_properties ⇒ Hash{String => Object}
142 143 144 |
# File 'msk/cfn_vpc_connection.rb', line 142 def cfn_properties() jsii_get_property("cfnProperties") end |
#cfn_property_name(cdk_property_name) ⇒ String?
473 474 475 476 |
# File 'msk/cfn_vpc_connection.rb', line 473 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}
147 148 149 |
# File 'msk/cfn_vpc_connection.rb', line 147 def cfn_property_names() jsii_get_property("cfnPropertyNames") end |
#cfn_resource_type ⇒ String
AWS resource type.
154 155 156 |
# File 'msk/cfn_vpc_connection.rb', line 154 def cfn_resource_type() jsii_get_property("cfnResourceType") end |
#client_subnets ⇒ Array<String>
The list of subnets in the client VPC to connect to.
224 225 226 |
# File 'msk/cfn_vpc_connection.rb', line 224 def client_subnets() jsii_get_property("clientSubnets") end |
#client_subnets=(value) ⇒ Object
228 229 230 231 |
# File 'msk/cfn_vpc_connection.rb', line 228 def client_subnets=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "clientSubnets") jsii_set_property("clientSubnets", value) end |
#creation_stack ⇒ Array<String>
99 100 101 |
# File 'msk/cfn_vpc_connection.rb', line 99 def creation_stack() jsii_get_property("creationStack") end |
#env ⇒ AWSCDK::Interfaces::ResourceEnvironment
159 160 161 |
# File 'msk/cfn_vpc_connection.rb', line 159 def env() jsii_get_property("env") 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.
486 487 488 489 490 |
# File 'msk/cfn_vpc_connection.rb', line 486 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.
497 498 499 500 |
# File 'msk/cfn_vpc_connection.rb', line 497 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.
567 568 569 570 |
# File 'msk/cfn_vpc_connection.rb', line 567 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).
111 112 113 |
# File 'msk/cfn_vpc_connection.rb', line 111 def logical_id() jsii_get_property("logicalId") end |
#node ⇒ Constructs::Node
The tree node.
94 95 96 |
# File 'msk/cfn_vpc_connection.rb', line 94 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.
508 509 510 |
# File 'msk/cfn_vpc_connection.rb', line 508 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.
515 516 517 |
# File 'msk/cfn_vpc_connection.rb', line 515 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.
308 309 310 311 |
# File 'msk/cfn_vpc_connection.rb', line 308 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 }).
130 131 132 |
# File 'msk/cfn_vpc_connection.rb', line 130 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.
526 527 528 529 |
# File 'msk/cfn_vpc_connection.rb', line 526 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}
533 534 535 536 |
# File 'msk/cfn_vpc_connection.rb', line 533 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.
543 544 545 546 547 |
# File 'msk/cfn_vpc_connection.rb', line 543 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 |
#security_groups ⇒ Array<String>
The security groups to attach to the ENIs for the broker nodes.
236 237 238 |
# File 'msk/cfn_vpc_connection.rb', line 236 def security_groups() jsii_get_property("securityGroups") end |
#security_groups=(value) ⇒ Object
240 241 242 243 |
# File 'msk/cfn_vpc_connection.rb', line 240 def security_groups=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "securityGroups") jsii_set_property("securityGroups", value) end |
#should_synthesize ⇒ Boolean
Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
552 553 554 |
# File 'msk/cfn_vpc_connection.rb', line 552 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).
120 121 122 |
# File 'msk/cfn_vpc_connection.rb', line 120 def stack() jsii_get_property("stack") end |
#tags ⇒ AWSCDK::TagManager
Tag Manager which manages the tags for this resource.
198 199 200 |
# File 'msk/cfn_vpc_connection.rb', line 198 def () jsii_get_property("tags") end |
#tags_raw ⇒ Hash{String => String}?
An arbitrary set of tags (key-value pairs) you specify while creating the VPC connection.
272 273 274 |
# File 'msk/cfn_vpc_connection.rb', line 272 def () jsii_get_property("tagsRaw") end |
#tags_raw=(value) ⇒ Object
276 277 278 279 |
# File 'msk/cfn_vpc_connection.rb', line 276 def (value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoibWFwIn19")), "tagsRaw") unless value.nil? jsii_set_property("tagsRaw", value) end |
#target_cluster_arn ⇒ String
The Amazon Resource Name (ARN) of the cluster.
248 249 250 |
# File 'msk/cfn_vpc_connection.rb', line 248 def target_cluster_arn() jsii_get_property("targetClusterArn") end |
#target_cluster_arn=(value) ⇒ Object
252 253 254 255 |
# File 'msk/cfn_vpc_connection.rb', line 252 def target_cluster_arn=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "targetClusterArn") jsii_set_property("targetClusterArn", value) end |
#to_string ⇒ String
Returns a string representation of this construct.
284 285 286 |
# File 'msk/cfn_vpc_connection.rb', line 284 def to_string() jsii_call_method("toString", []) 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.
167 168 169 |
# File 'msk/cfn_vpc_connection.rb', line 167 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.
177 178 179 |
# File 'msk/cfn_vpc_connection.rb', line 177 def updated_properties() jsii_get_property("updatedProperties") end |
#validate_properties(_properties) ⇒ void
This method returns an undefined value.
558 559 560 561 |
# File 'msk/cfn_vpc_connection.rb', line 558 def validate_properties(_properties) Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties") jsii_call_method("validateProperties", [_properties]) end |
#vpc_connection_ref ⇒ AWSCDK::Interfaces::AWSMSK::VPCConnectionReference
A reference to a VpcConnection resource.
205 206 207 |
# File 'msk/cfn_vpc_connection.rb', line 205 def vpc_connection_ref() jsii_get_property("vpcConnectionRef") end |
#vpc_id ⇒ String
The VPC ID of the remote client.
260 261 262 |
# File 'msk/cfn_vpc_connection.rb', line 260 def vpc_id() jsii_get_property("vpcId") end |
#vpc_id=(value) ⇒ Object
264 265 266 267 |
# File 'msk/cfn_vpc_connection.rb', line 264 def vpc_id=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "vpcId") jsii_set_property("vpcId", value) 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.
297 298 299 300 301 302 |
# File 'msk/cfn_vpc_connection.rb', line 297 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 |