Class: AWSCDK::ODB::CfnOdbNetworkProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
odb/cfn_odb_network_props.rb

Overview

Properties for defining a CfnOdbNetwork.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(availability_zone: nil, availability_zone_id: nil, backup_subnet_cidr: nil, client_subnet_cidr: nil, cross_region_s3_restore_sources: nil, custom_domain_name: nil, default_dns_prefix: nil, delete_associated_resources: nil, display_name: nil, kms_access: nil, kms_policy_document: nil, s3_access: nil, s3_policy_document: nil, sts_access: nil, sts_policy_document: nil, tags: nil, zero_etl_access: nil) ⇒ CfnOdbNetworkProps

Returns a new instance of CfnOdbNetworkProps.

Parameters:

  • availability_zone (String, nil) (defaults to: nil) —

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

  • availability_zone_id (String, nil) (defaults to: nil) —

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

  • backup_subnet_cidr (String, nil) (defaults to: nil) —

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

  • client_subnet_cidr (String, nil) (defaults to: nil) —

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

  • cross_region_s3_restore_sources (Array<String>, nil) (defaults to: nil) —

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

  • custom_domain_name (String, nil) (defaults to: nil) —

    The domain name for the resources in the ODB network.

  • default_dns_prefix (String, nil) (defaults to: nil) —

    The DNS prefix to the default DNS domain name.

  • delete_associated_resources (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

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

  • display_name (String, nil) (defaults to: nil) —

    The user-friendly name of the ODB network.

  • kms_access (String, nil) (defaults to: nil) —

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

  • kms_policy_document (String, nil) (defaults to: nil) —

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

  • s3_access (String, nil) (defaults to: nil) —

    The configuration for Amazon S3 access from the ODB network.

  • s3_policy_document (String, nil) (defaults to: nil) —

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

  • sts_access (String, nil) (defaults to: nil) —

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

  • sts_policy_document (String, nil) (defaults to: nil) —

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

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    Tags to assign to the Odb Network.

  • zero_etl_access (String, nil) (defaults to: nil) —

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



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
 
# File 'odb/cfn_odb_network_props.rb', line 26

def initialize(availability_zone: nil, availability_zone_id: nil, backup_subnet_cidr: nil, client_subnet_cidr: nil, cross_region_s3_restore_sources: nil, custom_domain_name: nil, default_dns_prefix: nil, delete_associated_resources: nil, display_name: nil, kms_access: nil, kms_policy_document: nil, s3_access: nil, s3_policy_document: nil, sts_access: nil, sts_policy_document: nil, tags: nil, zero_etl_access: nil)
  @availability_zone = availability_zone
  Jsii::Type.check_type(@availability_zone, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "availabilityZone") unless @availability_zone.nil?
  @availability_zone_id = availability_zone_id
  Jsii::Type.check_type(@availability_zone_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "availabilityZoneId") unless @availability_zone_id.nil?
  @backup_subnet_cidr = backup_subnet_cidr
  Jsii::Type.check_type(@backup_subnet_cidr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "backupSubnetCidr") unless @backup_subnet_cidr.nil?
  @client_subnet_cidr = client_subnet_cidr
  Jsii::Type.check_type(@client_subnet_cidr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "clientSubnetCidr") unless @client_subnet_cidr.nil?
  @cross_region_s3_restore_sources = cross_region_s3_restore_sources
  Jsii::Type.check_type(@cross_region_s3_restore_sources, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "crossRegionS3RestoreSources") unless @cross_region_s3_restore_sources.nil?
  @custom_domain_name = custom_domain_name
  Jsii::Type.check_type(@custom_domain_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "customDomainName") unless @custom_domain_name.nil?
  @default_dns_prefix = default_dns_prefix
  Jsii::Type.check_type(@default_dns_prefix, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "defaultDnsPrefix") unless @default_dns_prefix.nil?
  @delete_associated_resources = delete_associated_resources
  Jsii::Type.check_type(@delete_associated_resources, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "deleteAssociatedResources") unless @delete_associated_resources.nil?
  @display_name = display_name
  Jsii::Type.check_type(@display_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "displayName") unless @display_name.nil?
  @kms_access = kms_access
  Jsii::Type.check_type(@kms_access, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kmsAccess") unless @kms_access.nil?
  @kms_policy_document = kms_policy_document
  Jsii::Type.check_type(@kms_policy_document, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kmsPolicyDocument") unless @kms_policy_document.nil?
  @s3_access = s3_access
  Jsii::Type.check_type(@s3_access, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "s3Access") unless @s3_access.nil?
  @s3_policy_document = s3_policy_document
  Jsii::Type.check_type(@s3_policy_document, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "s3PolicyDocument") unless @s3_policy_document.nil?
  @sts_access = sts_access
  Jsii::Type.check_type(@sts_access, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "stsAccess") unless @sts_access.nil?
  @sts_policy_document = sts_policy_document
  Jsii::Type.check_type(@sts_policy_document, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "stsPolicyDocument") unless @sts_policy_document.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
  @zero_etl_access = zero_etl_access
  Jsii::Type.check_type(@zero_etl_access, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "zeroEtlAccess") unless @zero_etl_access.nil?
end

Instance Attribute Details

#availability_zone ⇒ String? (readonly)

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

Required when creating an ODB network. Specify either AvailabilityZone or AvailabilityZoneId to define the location of the network.

Returns:

  • (String, nil)

See Also:



69
70
71
 
# File 'odb/cfn_odb_network_props.rb', line 69

def availability_zone
  @availability_zone
end

#availability_zone_id ⇒ String? (readonly)

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

Required when creating an ODB network. Specify either AvailabilityZone or AvailabilityZoneId to define the location of the network.

Returns:

  • (String, nil)

See Also:



76
77
78
 
# File 'odb/cfn_odb_network_props.rb', line 76

def availability_zone_id
  @availability_zone_id
end

#backup_subnet_cidr ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



81
82
83
 
# File 'odb/cfn_odb_network_props.rb', line 81

def backup_subnet_cidr
  @backup_subnet_cidr
end

#client_subnet_cidr ⇒ String? (readonly)

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

Required when creating an ODB network.

Returns:

  • (String, nil)

See Also:



88
89
90
 
# File 'odb/cfn_odb_network_props.rb', line 88

def client_subnet_cidr
  @client_subnet_cidr
end

#cross_region_s3_restore_sources ⇒ Array<String>? (readonly)

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

Returns:

  • (Array<String>, nil)

See Also:



93
94
95
 
# File 'odb/cfn_odb_network_props.rb', line 93

def cross_region_s3_restore_sources
  @cross_region_s3_restore_sources
end

#custom_domain_name ⇒ String? (readonly)

The domain name for the resources in the ODB network.

Returns:

  • (String, nil)

See Also:



98
99
100
 
# File 'odb/cfn_odb_network_props.rb', line 98

def custom_domain_name
  @custom_domain_name
end

#default_dns_prefix ⇒ String? (readonly)

The DNS prefix to the default DNS domain name.

The default DNS domain name is oraclevcn.com.

Returns:

  • (String, nil)

See Also:



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

def default_dns_prefix
  @default_dns_prefix
end

#delete_associated_resources ⇒ Boolean, ... (readonly)

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

Required when creating an ODB network.

Returns:

See Also:



112
113
114
 
# File 'odb/cfn_odb_network_props.rb', line 112

def delete_associated_resources
  @delete_associated_resources
end

#display_name ⇒ String? (readonly)

The user-friendly name of the ODB network.

Required when creating an ODB network.

Returns:

  • (String, nil)

See Also:



119
120
121
 
# File 'odb/cfn_odb_network_props.rb', line 119

def display_name
  @display_name
end

#kms_access ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



124
125
126
 
# File 'odb/cfn_odb_network_props.rb', line 124

def kms_access
  @kms_access
end

#kms_policy_document ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



129
130
131
 
# File 'odb/cfn_odb_network_props.rb', line 129

def kms_policy_document
  @kms_policy_document
end

#s3_access ⇒ String? (readonly)

The configuration for Amazon S3 access from the ODB network.

Returns:

  • (String, nil)

See Also:



134
135
136
 
# File 'odb/cfn_odb_network_props.rb', line 134

def s3_access
  @s3_access
end

#s3_policy_document ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



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

def s3_policy_document
  @s3_policy_document
end

#sts_access ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



144
145
146
 
# File 'odb/cfn_odb_network_props.rb', line 144

def sts_access
  @sts_access
end

#sts_policy_document ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



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

def sts_policy_document
  @sts_policy_document
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

Tags to assign to the Odb Network.

Returns:

See Also:



154
155
156
 
# File 'odb/cfn_odb_network_props.rb', line 154

def tags
  @tags
end

#zero_etl_access ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



159
160
161
 
# File 'odb/cfn_odb_network_props.rb', line 159

def zero_etl_access
  @zero_etl_access
end

Class Method Details

.jsii_properties ⇒ Object 



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'odb/cfn_odb_network_props.rb', line 161

def self.jsii_properties
  {
    :availability_zone => "availabilityZone",
    :availability_zone_id => "availabilityZoneId",
    :backup_subnet_cidr => "backupSubnetCidr",
    :client_subnet_cidr => "clientSubnetCidr",
    :cross_region_s3_restore_sources => "crossRegionS3RestoreSources",
    :custom_domain_name => "customDomainName",
    :default_dns_prefix => "defaultDnsPrefix",
    :delete_associated_resources => "deleteAssociatedResources",
    :display_name => "displayName",
    :kms_access => "kmsAccess",
    :kms_policy_document => "kmsPolicyDocument",
    :s3_access => "s3Access",
    :s3_policy_document => "s3PolicyDocument",
    :sts_access => "stsAccess",
    :sts_policy_document => "stsPolicyDocument",
    :tags => "tags",
    :zero_etl_access => "zeroEtlAccess",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'odb/cfn_odb_network_props.rb', line 183

def to_jsii
  result = {}
  result.merge!({
    "availabilityZone" => @availability_zone,
    "availabilityZoneId" => @availability_zone_id,
    "backupSubnetCidr" => @backup_subnet_cidr,
    "clientSubnetCidr" => @client_subnet_cidr,
    "crossRegionS3RestoreSources" => @cross_region_s3_restore_sources,
    "customDomainName" => @custom_domain_name,
    "defaultDnsPrefix" => @default_dns_prefix,
    "deleteAssociatedResources" => @delete_associated_resources,
    "displayName" => @display_name,
    "kmsAccess" => @kms_access,
    "kmsPolicyDocument" => @kms_policy_document,
    "s3Access" => @s3_access,
    "s3PolicyDocument" => @s3_policy_document,
    "stsAccess" => @sts_access,
    "stsPolicyDocument" => @sts_policy_document,
    "tags" => @tags,
    "zeroEtlAccess" => @zero_etl_access,
  })
  result.compact
end