Class: AWSCDK::EC2::CfnVPCCIDRBlock

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, Interfaces::AWSEC2::IVPCCIDRBlockRef
Defined in:
ec2/cfn_vpccidr_block.rb

Overview

Associates a CIDR block with your VPC.

A VPC must have an associated IPv4 CIDR block. You can optionally associate additional IPv4 CIDR blocks with a VPC. You can optionally associate an IPv6 CIDR block with a VPC. You can request an Amazon-provided IPv6 CIDR block from Amazon's pool of IPv6 addresses, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (BYOIP).

For more information, see VPC CIDR blocks in the Amazon VPC User Guide .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnVPCCIDRBlock

Create a new AWS::EC2::VPCCidrBlock.

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::CfnVPCCIDRBlockProps) —

    Resource properties.



21
22
23
24
25
26
27
 
# File 'ec2/cfn_vpccidr_block.rb', line 21

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

Class Method Details

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


185
186
187
 
# File 'ec2/cfn_vpccidr_block.rb', line 185

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

.is_cfn_vpc_cidr_block(x) ⇒ Boolean

Checks whether the given object is a CfnVPCCidrBlock.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


87
88
89
90
 
# File 'ec2/cfn_vpccidr_block.rb', line 87

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

.jsii_overridable_methods ⇒ Object 



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
 
# File 'ec2/cfn_vpccidr_block.rb', line 29

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 },
    :attr_ip_source => { kind: :property, name: "attrIpSource", is_optional: false },
    :attr_ipv6_address_attribute => { kind: :property, name: "attrIpv6AddressAttribute", is_optional: false },
    :vpc_cidr_block_ref => { kind: :property, name: "vpcCidrBlockRef", is_optional: false },
    :vpc_id => { kind: :property, name: "vpcId", is_optional: false },
    :amazon_provided_ipv6_cidr_block => { kind: :property, name: "amazonProvidedIpv6CidrBlock", is_optional: true },
    :cidr_block => { kind: :property, name: "cidrBlock", is_optional: true },
    :ipv4_ipam_pool_id => { kind: :property, name: "ipv4IpamPoolId", is_optional: true },
    :ipv4_netmask_length => { kind: :property, name: "ipv4NetmaskLength", is_optional: true },
    :ipv6_cidr_block => { kind: :property, name: "ipv6CidrBlock", is_optional: true },
    :ipv6_cidr_block_network_border_group => { kind: :property, name: "ipv6CidrBlockNetworkBorderGroup", is_optional: true },
    :ipv6_ipam_pool_id => { kind: :property, name: "ipv6IpamPoolId", is_optional: true },
    :ipv6_netmask_length => { kind: :property, name: "ipv6NetmaskLength", is_optional: true },
    :ipv6_pool => { kind: :property, name: "ipv6Pool", 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.



379
380
381
382
 
# File 'ec2/cfn_vpccidr_block.rb', line 379

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:



391
392
393
394
 
# File 'ec2/cfn_vpccidr_block.rb', line 391

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:



401
402
403
404
 
# File 'ec2/cfn_vpccidr_block.rb', line 401

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:



412
413
414
415
416
 
# File 'ec2/cfn_vpccidr_block.rb', line 412

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.


469
470
471
472
473
 
# File 'ec2/cfn_vpccidr_block.rb', line 469

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.



479
480
481
482
 
# File 'ec2/cfn_vpccidr_block.rb', line 479

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.



491
492
493
494
495
 
# File 'ec2/cfn_vpccidr_block.rb', line 491

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

#amazon_provided_ipv6_cidr_block ⇒ Boolean, ...

Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC.

Returns:



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

def amazon_provided_ipv6_cidr_block()
  jsii_get_property("amazonProvidedIpv6CidrBlock")
end

#amazon_provided_ipv6_cidr_block=(value) ⇒ Object 



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

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



504
505
506
507
 
# File 'ec2/cfn_vpccidr_block.rb', line 504

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:



526
527
528
529
530
531
 
# File 'ec2/cfn_vpccidr_block.rb', line 526

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 VPC associated CIDR Block.

Returns:

  • (String) 


192
193
194
 
# File 'ec2/cfn_vpccidr_block.rb', line 192

def attr_id()
  jsii_get_property("attrId")
end

#attr_ip_source ⇒ String

The source that allocated the IP address space.

byoip or amazon indicates public IP address space allocated by Amazon or space that you have allocated with Bring your own IP (BYOIP). none indicates private space.

Returns:

  • (String) 


201
202
203
 
# File 'ec2/cfn_vpccidr_block.rb', line 201

def attr_ip_source()
  jsii_get_property("attrIpSource")
end

#attr_ipv6_address_attribute ⇒ String

Public IPv6 addresses are those advertised on the internet from AWS .

Private IP addresses are not and cannot be advertised on the internet from AWS .

Returns:

  • (String) 


210
211
212
 
# File 'ec2/cfn_vpccidr_block.rb', line 210

def attr_ipv6_address_attribute()
  jsii_get_property("attrIpv6AddressAttribute")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



138
139
140
 
# File 'ec2/cfn_vpccidr_block.rb', line 138

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


143
144
145
 
# File 'ec2/cfn_vpccidr_block.rb', line 143

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


535
536
537
538
 
# File 'ec2/cfn_vpccidr_block.rb', line 535

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


148
149
150
 
# File 'ec2/cfn_vpccidr_block.rb', line 148

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


155
156
157
 
# File 'ec2/cfn_vpccidr_block.rb', line 155

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#cidr_block ⇒ String?

An IPv4 CIDR block to associate with the VPC.

Returns:

  • (String, nil) 


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

def cidr_block()
  jsii_get_property("cidrBlock")
end

#cidr_block=(value) ⇒ Object 



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

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

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


100
101
102
 
# File 'ec2/cfn_vpccidr_block.rb', line 100

def creation_stack()
  jsii_get_property("creationStack")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



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

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.

Parameters:

Returns:



548
549
550
551
552
 
# File 'ec2/cfn_vpccidr_block.rb', line 548

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:



559
560
561
562
 
# File 'ec2/cfn_vpccidr_block.rb', line 559

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:



629
630
631
632
 
# File 'ec2/cfn_vpccidr_block.rb', line 629

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

#ipv4_ipam_pool_id ⇒ String?

Associate a CIDR allocated from an IPv4 IPAM pool to a VPC.

Returns:

  • (String, nil) 


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

def ipv4_ipam_pool_id()
  jsii_get_property("ipv4IpamPoolId")
end

#ipv4_ipam_pool_id=(value) ⇒ Object 



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

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

#ipv4_netmask_length ⇒ Numeric?

The netmask length of the IPv4 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool.

Returns:

  • (Numeric, nil) 


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

def ipv4_netmask_length()
  jsii_get_property("ipv4NetmaskLength")
end

#ipv4_netmask_length=(value) ⇒ Object 



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

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

#ipv6_cidr_block ⇒ String?

An IPv6 CIDR block from the IPv6 address pool.

You must also specify Ipv6Pool in the request.

Returns:

  • (String, nil) 


286
287
288
 
# File 'ec2/cfn_vpccidr_block.rb', line 286

def ipv6_cidr_block()
  jsii_get_property("ipv6CidrBlock")
end

#ipv6_cidr_block=(value) ⇒ Object 



290
291
292
293
 
# File 'ec2/cfn_vpccidr_block.rb', line 290

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

#ipv6_cidr_block_network_border_group ⇒ String?

The name of the location from which we advertise the IPV6 CIDR block.

Returns:

  • (String, nil) 


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

def ipv6_cidr_block_network_border_group()
  jsii_get_property("ipv6CidrBlockNetworkBorderGroup")
end

#ipv6_cidr_block_network_border_group=(value) ⇒ Object 



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

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

#ipv6_ipam_pool_id ⇒ String?

Associates a CIDR allocated from an IPv6 IPAM pool to a VPC.

Returns:

  • (String, nil) 


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

def ipv6_ipam_pool_id()
  jsii_get_property("ipv6IpamPoolId")
end

#ipv6_ipam_pool_id=(value) ⇒ Object 



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

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

#ipv6_netmask_length ⇒ Numeric?

The netmask length of the IPv6 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool.

Returns:

  • (Numeric, nil) 


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

def ipv6_netmask_length()
  jsii_get_property("ipv6NetmaskLength")
end

#ipv6_netmask_length=(value) ⇒ Object 



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

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

#ipv6_pool ⇒ String?

The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.

Returns:

  • (String, nil) 


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

def ipv6_pool()
  jsii_get_property("ipv6Pool")
end

#ipv6_pool=(value) ⇒ Object 



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

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


112
113
114
 
# File 'ec2/cfn_vpccidr_block.rb', line 112

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


95
96
97
 
# File 'ec2/cfn_vpccidr_block.rb', line 95

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:



570
571
572
 
# File 'ec2/cfn_vpccidr_block.rb', line 570

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:



577
578
579
 
# File 'ec2/cfn_vpccidr_block.rb', line 577

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.



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

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) 


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

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:



588
589
590
591
 
# File 'ec2/cfn_vpccidr_block.rb', line 588

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


595
596
597
598
 
# File 'ec2/cfn_vpccidr_block.rb', line 595

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:



605
606
607
608
609
 
# File 'ec2/cfn_vpccidr_block.rb', line 605

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.

Returns:

  • (Boolean) —

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



614
615
616
 
# File 'ec2/cfn_vpccidr_block.rb', line 614

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:



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

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



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

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

#updated_properites ⇒ Hash{String => Object}

Deprecated.

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

Deprecated.

Returns:

  • (Hash{String => Object}) 


168
169
170
 
# File 'ec2/cfn_vpccidr_block.rb', line 168

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


178
179
180
 
# File 'ec2/cfn_vpccidr_block.rb', line 178

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


620
621
622
623
 
# File 'ec2/cfn_vpccidr_block.rb', line 620

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

#vpc_cidr_block_ref ⇒ AWSCDK::Interfaces::AWSEC2::VPCCIDRBlockReference

A reference to a VPCCidrBlock resource.

Returns:



217
218
219
 
# File 'ec2/cfn_vpccidr_block.rb', line 217

def vpc_cidr_block_ref()
  jsii_get_property("vpcCidrBlockRef")
end

#vpc_id ⇒ String

The ID of the VPC.

Returns:

  • (String) 


224
225
226
 
# File 'ec2/cfn_vpccidr_block.rb', line 224

def vpc_id()
  jsii_get_property("vpcId")
end

#vpc_id=(value) ⇒ Object 



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

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.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


359
360
361
362
363
364
 
# File 'ec2/cfn_vpccidr_block.rb', line 359

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