Class: Google::Apis::ComposerV1::PrivateEnvironmentConfig

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/composer_v1/classes.rb,
lib/google/apis/composer_v1/representations.rb,
lib/google/apis/composer_v1/representations.rb

Overview

The configuration information for configuring a Private IP Cloud Composer environment.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ PrivateEnvironmentConfig

Returns a new instance of PrivateEnvironmentConfig.



1431
1432
1433
# File 'lib/google/apis/composer_v1/classes.rb', line 1431

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#cloud_composer_connection_subnetworkString

Optional. When specified, the environment will use Private Service Connect instead of VPC peerings to connect to Cloud SQL in the Tenant Project, and the PSC endpoint in the Customer Project will use an IP address from this subnetwork. Corresponds to the JSON property cloudComposerConnectionSubnetwork

Returns:

  • (String)


1365
1366
1367
# File 'lib/google/apis/composer_v1/classes.rb', line 1365

def cloud_composer_connection_subnetwork
  @cloud_composer_connection_subnetwork
end

#cloud_composer_network_ipv4_cidr_blockString

Optional. The CIDR block from which IP range for Cloud Composer Network in tenant project will be reserved. Needs to be disjoint from private_cluster_config.master_ipv4_cidr_block and cloud_sql_ipv4_cidr_block. This field is supported for Cloud Composer environments in versions composer-2. .-airflow-..* and newer. Corresponds to the JSON property cloudComposerNetworkIpv4CidrBlock

Returns:

  • (String)


1374
1375
1376
# File 'lib/google/apis/composer_v1/classes.rb', line 1374

def cloud_composer_network_ipv4_cidr_block
  @cloud_composer_network_ipv4_cidr_block
end

#cloud_composer_network_ipv4_reserved_rangeString

Output only. The IP range reserved for the tenant project's Cloud Composer network. This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer. Corresponds to the JSON property cloudComposerNetworkIpv4ReservedRange

Returns:

  • (String)


1381
1382
1383
# File 'lib/google/apis/composer_v1/classes.rb', line 1381

def cloud_composer_network_ipv4_reserved_range
  @cloud_composer_network_ipv4_reserved_range
end

#cloud_sql_ipv4_cidr_blockString

Optional. The CIDR block from which IP range in tenant project will be reserved for Cloud SQL. Needs to be disjoint from web_server_ipv4_cidr_block. Corresponds to the JSON property cloudSqlIpv4CidrBlock

Returns:

  • (String)


1387
1388
1389
# File 'lib/google/apis/composer_v1/classes.rb', line 1387

def cloud_sql_ipv4_cidr_block
  @cloud_sql_ipv4_cidr_block
end

#enable_private_environmentBoolean Also known as: enable_private_environment?

Optional. If true, a Private IP Cloud Composer environment is created. If this field is set to true, IPAllocationPolicy.use_ip_aliases must be set to true for Cloud Composer environments in versions composer-1..-airflow-..*. Corresponds to the JSON property enablePrivateEnvironment

Returns:

  • (Boolean)


1394
1395
1396
# File 'lib/google/apis/composer_v1/classes.rb', line 1394

def enable_private_environment
  @enable_private_environment
end

#enable_privately_used_public_ipsBoolean Also known as: enable_privately_used_public_ips?

Optional. When enabled, IPs from public (non-RFC1918) ranges can be used for IPAllocationPolicy.cluster_ipv4_cidr_block and IPAllocationPolicy. service_ipv4_cidr_block. Corresponds to the JSON property enablePrivatelyUsedPublicIps

Returns:

  • (Boolean)


1402
1403
1404
# File 'lib/google/apis/composer_v1/classes.rb', line 1402

def enable_privately_used_public_ips
  @enable_privately_used_public_ips
end

#networking_configGoogle::Apis::ComposerV1::NetworkingConfig

Configuration options for networking connections in the Composer 2 environment. Corresponds to the JSON property networkingConfig



1408
1409
1410
# File 'lib/google/apis/composer_v1/classes.rb', line 1408

def networking_config
  @networking_config
end

#private_cluster_configGoogle::Apis::ComposerV1::PrivateClusterConfig

Configuration options for the private GKE cluster in a Cloud Composer environment. Corresponds to the JSON property privateClusterConfig



1414
1415
1416
# File 'lib/google/apis/composer_v1/classes.rb', line 1414

def private_cluster_config
  @private_cluster_config
end

#web_server_ipv4_cidr_blockString

Optional. The CIDR block from which IP range for web server will be reserved. Needs to be disjoint from private_cluster_config.master_ipv4_cidr_block and cloud_sql_ipv4_cidr_block. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*. Corresponds to the JSON property webServerIpv4CidrBlock

Returns:

  • (String)


1422
1423
1424
# File 'lib/google/apis/composer_v1/classes.rb', line 1422

def web_server_ipv4_cidr_block
  @web_server_ipv4_cidr_block
end

#web_server_ipv4_reserved_rangeString

Output only. The IP range reserved for the tenant project's App Engine VMs. This field is supported for Cloud Composer environments in versions composer-1. .-airflow-..*. Corresponds to the JSON property webServerIpv4ReservedRange

Returns:

  • (String)


1429
1430
1431
# File 'lib/google/apis/composer_v1/classes.rb', line 1429

def web_server_ipv4_reserved_range
  @web_server_ipv4_reserved_range
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
# File 'lib/google/apis/composer_v1/classes.rb', line 1436

def update!(**args)
  @cloud_composer_connection_subnetwork = args[:cloud_composer_connection_subnetwork] if args.key?(:cloud_composer_connection_subnetwork)
  @cloud_composer_network_ipv4_cidr_block = args[:cloud_composer_network_ipv4_cidr_block] if args.key?(:cloud_composer_network_ipv4_cidr_block)
  @cloud_composer_network_ipv4_reserved_range = args[:cloud_composer_network_ipv4_reserved_range] if args.key?(:cloud_composer_network_ipv4_reserved_range)
  @cloud_sql_ipv4_cidr_block = args[:cloud_sql_ipv4_cidr_block] if args.key?(:cloud_sql_ipv4_cidr_block)
  @enable_private_environment = args[:enable_private_environment] if args.key?(:enable_private_environment)
  @enable_privately_used_public_ips = args[:enable_privately_used_public_ips] if args.key?(:enable_privately_used_public_ips)
  @networking_config = args[:networking_config] if args.key?(:networking_config)
  @private_cluster_config = args[:private_cluster_config] if args.key?(:private_cluster_config)
  @web_server_ipv4_cidr_block = args[:web_server_ipv4_cidr_block] if args.key?(:web_server_ipv4_cidr_block)
  @web_server_ipv4_reserved_range = args[:web_server_ipv4_reserved_range] if args.key?(:web_server_ipv4_reserved_range)
end