Class: AWSCDK::ODB::CfnOdbNetwork

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSOdb::IOdbNetworkRef
Defined in:
odb/cfn_odb_network.rb

Overview

The AWS::ODB::OdbNetwork resource creates an ODB network.

An ODB network provides the networking foundation for Oracle Database resources.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ CfnOdbNetwork

Create a new AWS::ODB::OdbNetwork.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::ODB::CfnOdbNetworkProps, nil) (defaults to: nil) —

    Resource properties.



20
21
22
23
24
25
26
 
# File 'odb/cfn_odb_network.rb', line 20

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::ODB::CfnOdbNetworkProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfb2RiLkNmbk9kYk5ldHdvcmtQcm9wcyJ9")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_odb_network(resource) ⇒ String

Parameters:

Returns:

  • (String) 


96
97
98
99
 
# File 'odb/cfn_odb_network.rb', line 96

def self.arn_for_odb_network(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19vZGIuSU9kYk5ldHdvcmtSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_odb.CfnOdbNetwork", "arnForOdbNetwork", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


203
204
205
 
# File 'odb/cfn_odb_network.rb', line 203

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

.is_cfn_odb_network(x) ⇒ Boolean

Checks whether the given object is a CfnOdbNetwork.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


105
106
107
108
 
# File 'odb/cfn_odb_network.rb', line 105

def self.is_cfn_odb_network(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_odb.CfnOdbNetwork", "isCfnOdbNetwork", [x])
end

.jsii_overridable_methods ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'odb/cfn_odb_network.rb', line 28

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_ec2_placement_group_ids => { kind: :property, name: "attrEc2PlacementGroupIds", is_optional: false },
    :attr_managed_services => { kind: :property, name: "attrManagedServices", is_optional: false },
    :attr_oci_network_anchor_id => { kind: :property, name: "attrOciNetworkAnchorId", is_optional: false },
    :attr_oci_resource_anchor_name => { kind: :property, name: "attrOciResourceAnchorName", is_optional: false },
    :attr_oci_vcn_url => { kind: :property, name: "attrOciVcnUrl", is_optional: false },
    :attr_odb_network_arn => { kind: :property, name: "attrOdbNetworkArn", is_optional: false },
    :attr_odb_network_id => { kind: :property, name: "attrOdbNetworkId", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :odb_network_ref => { kind: :property, name: "odbNetworkRef", is_optional: false },
    :availability_zone => { kind: :property, name: "availabilityZone", is_optional: true },
    :availability_zone_id => { kind: :property, name: "availabilityZoneId", is_optional: true },
    :backup_subnet_cidr => { kind: :property, name: "backupSubnetCidr", is_optional: true },
    :client_subnet_cidr => { kind: :property, name: "clientSubnetCidr", is_optional: true },
    :cross_region_s3_restore_sources => { kind: :property, name: "crossRegionS3RestoreSources", is_optional: true },
    :custom_domain_name => { kind: :property, name: "customDomainName", is_optional: true },
    :default_dns_prefix => { kind: :property, name: "defaultDnsPrefix", is_optional: true },
    :delete_associated_resources => { kind: :property, name: "deleteAssociatedResources", is_optional: true },
    :display_name => { kind: :property, name: "displayName", is_optional: true },
    :kms_access => { kind: :property, name: "kmsAccess", is_optional: true },
    :kms_policy_document => { kind: :property, name: "kmsPolicyDocument", is_optional: true },
    :s3_access => { kind: :property, name: "s3Access", is_optional: true },
    :s3_policy_document => { kind: :property, name: "s3PolicyDocument", is_optional: true },
    :sts_access => { kind: :property, name: "stsAccess", is_optional: true },
    :sts_policy_document => { kind: :property, name: "stsPolicyDocument", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :zero_etl_access => { kind: :property, name: "zeroEtlAccess", 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.



511
512
513
514
 
# File 'odb/cfn_odb_network.rb', line 511

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:



523
524
525
526
 
# File 'odb/cfn_odb_network.rb', line 523

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:



533
534
535
536
 
# File 'odb/cfn_odb_network.rb', line 533

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:



544
545
546
547
548
 
# File 'odb/cfn_odb_network.rb', line 544

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.


601
602
603
604
605
 
# File 'odb/cfn_odb_network.rb', line 601

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.



611
612
613
614
 
# File 'odb/cfn_odb_network.rb', line 611

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.



623
624
625
626
627
 
# File 'odb/cfn_odb_network.rb', line 623

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



636
637
638
639
 
# File 'odb/cfn_odb_network.rb', line 636

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:



658
659
660
661
662
663
 
# File 'odb/cfn_odb_network.rb', line 658

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_ec2_placement_group_ids ⇒ Array<String>

The list of EC2 placement group IDs associated with your ODB network.

Returns:

  • (Array<String>) 


210
211
212
 
# File 'odb/cfn_odb_network.rb', line 210

def attr_ec2_placement_group_ids()
  jsii_get_property("attrEc2PlacementGroupIds")
end

#attr_managed_services ⇒ AWSCDK::IResolvable

The managed services configuration for the ODB network.

Returns:



217
218
219
 
# File 'odb/cfn_odb_network.rb', line 217

def attr_managed_services()
  jsii_get_property("attrManagedServices")
end

#attr_oci_network_anchor_id ⇒ String

The unique identifier of the OCI network anchor for the ODB network.

Returns:

  • (String) 


224
225
226
 
# File 'odb/cfn_odb_network.rb', line 224

def attr_oci_network_anchor_id()
  jsii_get_property("attrOciNetworkAnchorId")
end

#attr_oci_resource_anchor_name ⇒ String

The name of the OCI resource anchor that's associated with the ODB network.

Returns:

  • (String) 


231
232
233
 
# File 'odb/cfn_odb_network.rb', line 231

def attr_oci_resource_anchor_name()
  jsii_get_property("attrOciResourceAnchorName")
end

#attr_oci_vcn_url ⇒ String

The URL for the VCN that's associated with the ODB network.

Returns:

  • (String) 


238
239
240
 
# File 'odb/cfn_odb_network.rb', line 238

def attr_oci_vcn_url()
  jsii_get_property("attrOciVcnUrl")
end

#attr_odb_network_arn ⇒ String

The Amazon Resource Name (ARN) of the ODB network.

Returns:

  • (String) 


245
246
247
 
# File 'odb/cfn_odb_network.rb', line 245

def attr_odb_network_arn()
  jsii_get_property("attrOdbNetworkArn")
end

#attr_odb_network_id ⇒ String

The unique identifier of the ODB network.

Returns:

  • (String) 


252
253
254
 
# File 'odb/cfn_odb_network.rb', line 252

def attr_odb_network_id()
  jsii_get_property("attrOdbNetworkId")
end

#availability_zone ⇒ String?

The Availability Zone (AZ) where the ODB network is located.

Returns:

  • (String, nil) 


273
274
275
 
# File 'odb/cfn_odb_network.rb', line 273

def availability_zone()
  jsii_get_property("availabilityZone")
end

#availability_zone=(value) ⇒ Object 



277
278
279
280
 
# File 'odb/cfn_odb_network.rb', line 277

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

#availability_zone_id ⇒ String?

The AZ ID of the AZ where the ODB network is located.

Returns:

  • (String, nil) 


285
286
287
 
# File 'odb/cfn_odb_network.rb', line 285

def availability_zone_id()
  jsii_get_property("availabilityZoneId")
end

#availability_zone_id=(value) ⇒ Object 



289
290
291
292
 
# File 'odb/cfn_odb_network.rb', line 289

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

#backup_subnet_cidr ⇒ String?

The CIDR range of the backup subnet in the ODB network.

Returns:

  • (String, nil) 


297
298
299
 
# File 'odb/cfn_odb_network.rb', line 297

def backup_subnet_cidr()
  jsii_get_property("backupSubnetCidr")
end

#backup_subnet_cidr=(value) ⇒ Object 



301
302
303
304
 
# File 'odb/cfn_odb_network.rb', line 301

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

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



259
260
261
 
# File 'odb/cfn_odb_network.rb', line 259

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



156
157
158
 
# File 'odb/cfn_odb_network.rb', line 156

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


161
162
163
 
# File 'odb/cfn_odb_network.rb', line 161

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


667
668
669
670
 
# File 'odb/cfn_odb_network.rb', line 667

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


166
167
168
 
# File 'odb/cfn_odb_network.rb', line 166

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


173
174
175
 
# File 'odb/cfn_odb_network.rb', line 173

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#client_subnet_cidr ⇒ String?

The CIDR range of the client subnet in the ODB network.

Returns:

  • (String, nil) 


309
310
311
 
# File 'odb/cfn_odb_network.rb', line 309

def client_subnet_cidr()
  jsii_get_property("clientSubnetCidr")
end

#client_subnet_cidr=(value) ⇒ Object 



313
314
315
316
 
# File 'odb/cfn_odb_network.rb', line 313

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

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


118
119
120
 
# File 'odb/cfn_odb_network.rb', line 118

def creation_stack()
  jsii_get_property("creationStack")
end

#cross_region_s3_restore_sources ⇒ Array<String>?

The cross-Region Amazon S3 restore sources for the ODB network.

Returns:

  • (Array<String>, nil) 


321
322
323
 
# File 'odb/cfn_odb_network.rb', line 321

def cross_region_s3_restore_sources()
  jsii_get_property("crossRegionS3RestoreSources")
end

#cross_region_s3_restore_sources=(value) ⇒ Object 



325
326
327
328
 
# File 'odb/cfn_odb_network.rb', line 325

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

#custom_domain_name ⇒ String?

The domain name for the resources in the ODB network.

Returns:

  • (String, nil) 


333
334
335
 
# File 'odb/cfn_odb_network.rb', line 333

def custom_domain_name()
  jsii_get_property("customDomainName")
end

#custom_domain_name=(value) ⇒ Object 



337
338
339
340
 
# File 'odb/cfn_odb_network.rb', line 337

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

#default_dns_prefix ⇒ String?

The DNS prefix to the default DNS domain name.

Returns:

  • (String, nil) 


345
346
347
 
# File 'odb/cfn_odb_network.rb', line 345

def default_dns_prefix()
  jsii_get_property("defaultDnsPrefix")
end

#default_dns_prefix=(value) ⇒ Object 



349
350
351
352
 
# File 'odb/cfn_odb_network.rb', line 349

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

#delete_associated_resources ⇒ Boolean, ...

Specifies whether to delete associated OCI networking resources along with the ODB network.

Returns:



357
358
359
 
# File 'odb/cfn_odb_network.rb', line 357

def delete_associated_resources()
  jsii_get_property("deleteAssociatedResources")
end

#delete_associated_resources=(value) ⇒ Object 



361
362
363
364
 
# File 'odb/cfn_odb_network.rb', line 361

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

#display_name ⇒ String?

The user-friendly name of the ODB network.

Returns:

  • (String, nil) 


369
370
371
 
# File 'odb/cfn_odb_network.rb', line 369

def display_name()
  jsii_get_property("displayName")
end

#display_name=(value) ⇒ Object 



373
374
375
376
 
# File 'odb/cfn_odb_network.rb', line 373

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



178
179
180
 
# File 'odb/cfn_odb_network.rb', line 178

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:



680
681
682
683
684
 
# File 'odb/cfn_odb_network.rb', line 680

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:



691
692
693
694
 
# File 'odb/cfn_odb_network.rb', line 691

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:



761
762
763
764
 
# File 'odb/cfn_odb_network.rb', line 761

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

#kms_access ⇒ String?

The AWS Key Management Service (KMS) access configuration for the ODB network.

Returns:

  • (String, nil) 


381
382
383
 
# File 'odb/cfn_odb_network.rb', line 381

def kms_access()
  jsii_get_property("kmsAccess")
end

#kms_access=(value) ⇒ Object 



385
386
387
388
 
# File 'odb/cfn_odb_network.rb', line 385

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

#kms_policy_document ⇒ String?

The AWS Key Management Service (KMS) policy document that defines permissions for key usage within the ODB network.

Returns:

  • (String, nil) 


393
394
395
 
# File 'odb/cfn_odb_network.rb', line 393

def kms_policy_document()
  jsii_get_property("kmsPolicyDocument")
end

#kms_policy_document=(value) ⇒ Object 



397
398
399
400
 
# File 'odb/cfn_odb_network.rb', line 397

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


130
131
132
 
# File 'odb/cfn_odb_network.rb', line 130

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


113
114
115
 
# File 'odb/cfn_odb_network.rb', line 113

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:



702
703
704
 
# File 'odb/cfn_odb_network.rb', line 702

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:



709
710
711
 
# File 'odb/cfn_odb_network.rb', line 709

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#odb_network_ref ⇒ AWSCDK::Interfaces::AWSOdb::OdbNetworkReference

A reference to a OdbNetwork resource.

Returns:



266
267
268
 
# File 'odb/cfn_odb_network.rb', line 266

def odb_network_ref()
  jsii_get_property("odbNetworkRef")
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.



502
503
504
505
 
# File 'odb/cfn_odb_network.rb', line 502

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) 


149
150
151
 
# File 'odb/cfn_odb_network.rb', line 149

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:



720
721
722
723
 
# File 'odb/cfn_odb_network.rb', line 720

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


727
728
729
730
 
# File 'odb/cfn_odb_network.rb', line 727

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:



737
738
739
740
741
 
# File 'odb/cfn_odb_network.rb', line 737

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

#s3_access ⇒ String?

The configuration for Amazon S3 access from the ODB network.

Returns:

  • (String, nil) 


405
406
407
 
# File 'odb/cfn_odb_network.rb', line 405

def s3_access()
  jsii_get_property("s3Access")
end

#s3_access=(value) ⇒ Object 



409
410
411
412
 
# File 'odb/cfn_odb_network.rb', line 409

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

#s3_policy_document ⇒ String?

Specifies the endpoint policy for Amazon S3 access from the ODB network.

Returns:

  • (String, nil) 


417
418
419
 
# File 'odb/cfn_odb_network.rb', line 417

def s3_policy_document()
  jsii_get_property("s3PolicyDocument")
end

#s3_policy_document=(value) ⇒ Object 



421
422
423
424
 
# File 'odb/cfn_odb_network.rb', line 421

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

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

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



746
747
748
 
# File 'odb/cfn_odb_network.rb', line 746

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:



139
140
141
 
# File 'odb/cfn_odb_network.rb', line 139

def stack()
  jsii_get_property("stack")
end

#sts_access ⇒ String?

The AWS Security Token Service (STS) access configuration for the ODB network.

Returns:

  • (String, nil) 


429
430
431
 
# File 'odb/cfn_odb_network.rb', line 429

def sts_access()
  jsii_get_property("stsAccess")
end

#sts_access=(value) ⇒ Object 



433
434
435
436
 
# File 'odb/cfn_odb_network.rb', line 433

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

#sts_policy_document ⇒ String?

The AWS Security Token Service (STS) policy document that defines permissions for token service usage within the ODB network.

Returns:

  • (String, nil) 


441
442
443
 
# File 'odb/cfn_odb_network.rb', line 441

def sts_policy_document()
  jsii_get_property("stsPolicyDocument")
end

#sts_policy_document=(value) ⇒ Object 



445
446
447
448
 
# File 'odb/cfn_odb_network.rb', line 445

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

#tags ⇒ Array<AWSCDK::CfnTag>?

Tags to assign to the Odb Network.

Returns:



453
454
455
 
# File 'odb/cfn_odb_network.rb', line 453

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



457
458
459
460
461
 
# File 'odb/cfn_odb_network.rb', line 457

def tags=(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=")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



478
479
480
 
# File 'odb/cfn_odb_network.rb', line 478

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


186
187
188
 
# File 'odb/cfn_odb_network.rb', line 186

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


196
197
198
 
# File 'odb/cfn_odb_network.rb', line 196

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


752
753
754
755
 
# File 'odb/cfn_odb_network.rb', line 752

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

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


491
492
493
494
495
496
 
# File 'odb/cfn_odb_network.rb', line 491

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

#zero_etl_access ⇒ String?

The configuration for Zero-ETL access from the ODB network.

Returns:

  • (String, nil) 


466
467
468
 
# File 'odb/cfn_odb_network.rb', line 466

def zero_etl_access()
  jsii_get_property("zeroEtlAccess")
end

#zero_etl_access=(value) ⇒ Object 



470
471
472
473
 
# File 'odb/cfn_odb_network.rb', line 470

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