SubnetworkState class

Input properties used for looking up and filtering Subnetwork resources.

Constructors

SubnetworkState({Input<bool?>? allowSubnetCidrRoutesOverlap, Input<String?>? creationTimestamp, Input<String?>? deletionPolicy, Input<String?>? description, Input<String?>? externalIpv6Prefix, Input<String?>? fingerprint, Input<String?>? gatewayAddress, Input<String?>? internalIpv6Prefix, Input<String?>? ipCidrRange, Input<String?>? ipCollection, Input<String?>? ipv6AccessType, Input<String?>? ipv6CidrRange, Input<String?>? ipv6GceEndpoint, Input<SubnetworkLogConfig?>? logConfig, Input<String?>? name, Input<String?>? network, Input<SubnetworkParams?>? params, Input<bool?>? privateIpGoogleAccess, Input<String?>? privateIpv6GoogleAccess, Input<String?>? project, Input<String?>? purpose, Input<String?>? region, Input<String?>? reservedInternalRange, Input<String?>? resolveSubnetMask, Input<String?>? role, Input<List<SubnetworkSecondaryIpRange>?>? secondaryIpRanges, Input<String?>? selfLink, Input<bool?>? sendSecondaryIpRangeIfEmpty, Input<String?>? stackType, Input<String?>? state, Input<int?>? subnetworkId})

Creates a new SubnetworkState. allowSubnetCidrRoutesOverlap Typically packets destined to IPs within the subnetwork range that do not match creationTimestamp Creation timestamp in RFC3339 text format. deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. description An optional description of this resource. Provide this property when externalIpv6Prefix The range of external IPv6 addresses that are owned by this subnetwork. fingerprint Fingerprint of this resource. This field is used internally during updates of this resource. gatewayAddress The gateway address for default routes to reach destination addresses internalIpv6Prefix The internal IPv6 address range that is assigned to this subnetwork. ipCidrRange The range of internal addresses that are owned by this subnetwork. ipCollection Resource reference of a PublicDelegatedPrefix. The PDP must be a sub-PDP ipv6AccessType The access type of IPv6 address this subnet holds. It's immutable and can only be specified during creation ipv6CidrRange The range of internal IPv6 addresses that are owned by this subnetwork. ipv6GceEndpoint Possible endpoints of this subnetwork. It can be one of the following: logConfig This field denotes the VPC flow logging options for this subnetwork. If name The name of the resource, provided by the client when initially network The network this subnet belongs to. params Additional params passed with the request, but not persisted as part of resource payload privateIpGoogleAccess When enabled, VMs in this subnetwork without external IP addresses can privateIpv6GoogleAccess The private IPv6 google access type for the VMs in this subnet. project The ID of the project in which the resource belongs. purpose The purpose of the resource. This field can be either PRIVATE, REGIONAL_MANAGED_PROXY, GLOBAL_MANAGED_PROXY, PRIVATE_SERVICE_CONNECT, PEER_MIGRATION or PRIVATE_NAT(Beta). region The GCP region for this subnetwork. reservedInternalRange The ID of the reserved internal range. Must be prefixed with networkconnectivity.googleapis.com resolveSubnetMask 'Configures subnet mask resolution for this subnetwork.' role The role of subnetwork. secondaryIpRanges An array of configurations for secondary IP ranges for VM instances selfLink The URI of the created resource. sendSecondaryIpRangeIfEmpty Controls the removal behavior of secondary_ip_range. stackType The stack type for this subnet to identify whether the IPv6 feature is enabled or not. state 'The state of the subnetwork, which can be one of the following values: subnetworkId The unique identifier number for the resource. This identifier is defined by the server.

const

SubnetworkState.fromMap(Map<String, dynamic> map)

factory

Properties

allowSubnetCidrRoutesOverlap → Input<bool?>?

Typically packets destined to IPs within the subnetwork range that do not match existing resources are dropped and prevented from leaving the VPC. Setting this field to true will allow these packets to match dynamic routes injected via BGP even if their destinations match existing subnet ranges.

final

creationTimestamp → Input<String?>?

Creation timestamp in RFC3339 text format.

final

deletionPolicy → Input<String?>?

Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

final

description → Input<String?>?

An optional description of this resource. Provide this property when you create the resource. This field can be set only at resource creation time.

final

externalIpv6Prefix → Input<String?>?

The range of external IPv6 addresses that are owned by this subnetwork.

final

fingerprint → Input<String?>?

Fingerprint of this resource. This field is used internally during updates of this resource.

final

gatewayAddress → Input<String?>?

The gateway address for default routes to reach destination addresses outside this subnetwork.

final

hashCode → int

The hash code for this object.

no setter, inherited

internalIpv6Prefix → Input<String?>?

The internal IPv6 address range that is assigned to this subnetwork.

final

ipCidrRange → Input<String?>?

The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. Field is optional when reservedInternalRange is defined, otherwise required.

final

ipCollection → Input<String?>?

Resource reference of a PublicDelegatedPrefix. The PDP must be a sub-PDP in EXTERNAL_IPV6_SUBNETWORK_CREATION or INTERNAL_IPV6_SUBNETWORK_CREATION mode. Use one of the following formats to specify a sub-PDP when creating a dual stack or IPv6-only subnetwork using BYOIP: Full resource URL, as in:

final

ipv6AccessType → Input<String?>?

The access type of IPv6 address this subnet holds. It's immutable and can only be specified during creation or the first time the subnet is updated into IPV4_IPV6 dual stack. If the ipv6Type is EXTERNAL then this subnet cannot enable direct path. Possible values are: EXTERNAL, INTERNAL.

final

ipv6CidrRange → Input<String?>?

The range of internal IPv6 addresses that are owned by this subnetwork.

final

ipv6GceEndpoint → Input<String?>?

Possible endpoints of this subnetwork. It can be one of the following:

final

logConfig → Input<SubnetworkLogConfig?>?

This field denotes the VPC flow logging options for this subnetwork. If logging is enabled, logs are exported to Cloud Logging. Flow logging isn't supported if the subnet purpose field is set to subnetwork is REGIONAL_MANAGED_PROXY or GLOBAL_MANAGED_PROXY. Structure is documented below.

final

name → Input<String?>?

The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

final

network → Input<String?>?

The network this subnet belongs to. Only networks that are in the distributed mode can have subnetworks.

final

params → Input<SubnetworkParams?>?

Additional params passed with the request, but not persisted as part of resource payload Structure is documented below.

final

privateIpGoogleAccess → Input<bool?>?

When enabled, VMs in this subnetwork without external IP addresses can access Google APIs and services by using Private Google Access.

final

privateIpv6GoogleAccess → Input<String?>?

The private IPv6 google access type for the VMs in this subnet.

final

project → Input<String?>?

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

final

purpose → Input<String?>?

The purpose of the resource. This field can be either PRIVATE, REGIONAL_MANAGED_PROXY, GLOBAL_MANAGED_PROXY, PRIVATE_SERVICE_CONNECT, PEER_MIGRATION or PRIVATE_NAT(Beta). A subnet with purpose set to REGIONAL_MANAGED_PROXY is a user-created subnetwork that is reserved for regional Envoy-based load balancers. A subnetwork in a given region with purpose set to GLOBAL_MANAGED_PROXY is a proxy-only subnet and is shared between all the cross-regional Envoy-based load balancers. A subnetwork with purpose set to PRIVATE_SERVICE_CONNECT reserves the subnet for hosting a Private Service Connect published service. A subnetwork with purpose set to PEER_MIGRATION is a user created subnetwork that is reserved for migrating resources from one peered network to another. A subnetwork with purpose set to PRIVATE_NAT is used as source range for Private NAT gateways. Note that REGIONAL_MANAGED_PROXY is the preferred setting for all regional Envoy load balancers. If unspecified, the purpose defaults to PRIVATE.

final

region → Input<String?>?

The GCP region for this subnetwork.

final

reservedInternalRange → Input<String?>?

The ID of the reserved internal range. Must be prefixed with networkconnectivity.googleapis.com E.g. networkconnectivity.googleapis.com/projects/{project}/locations/global/internalRanges/{rangeId}

final

resolveSubnetMask → Input<String?>?

'Configures subnet mask resolution for this subnetwork.' Possible values are: ARP_ALL_RANGES, ARP_PRIMARY_RANGE, ARP_BROADCAST_PRIMARY_RANGE, ARP_BROADCAST_PRIMARY_RANGE_WITH_LEARNING.

final

role → Input<String?>?

The role of subnetwork. Currently, this field is only used when purpose is REGIONAL_MANAGED_PROXY. The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Envoy-based load balancers in a region. A BACKUP subnetwork is one that is ready to be promoted to ACTIVE or is currently draining. Possible values are: ACTIVE, BACKUP.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

secondaryIpRanges → Input<List<SubnetworkSecondaryIpRange>?>?

An array of configurations for secondary IP ranges for VM instances contained in this subnetwork. The primary IP of such VM must belong to the primary ipCidrRange of the subnetwork. The alias IPs may belong to either primary or secondary ranges. Structure is documented below.

final

selfLink → Input<String?>?

The URI of the created resource.

final

sendSecondaryIpRangeIfEmpty → Input<bool?>?

Controls the removal behavior of secondary_ip_range. When false, removing secondaryIpRange from config will not produce a diff as the provider will default to the API's value. When true, the provider will treat removing secondaryIpRange as sending an empty list of secondary IP ranges to the API. Defaults to false.

final

stackType → Input<String?>?

The stack type for this subnet to identify whether the IPv6 feature is enabled or not. If not specified IPV4_ONLY will be used. Possible values are: IPV4_ONLY, IPV4_IPV6, IPV6_ONLY.

final

state → Input<String?>?

'The state of the subnetwork, which can be one of the following values: READY: Subnetwork is created and ready to use DRAINING: only applicable to subnetworks that have the purpose set to INTERNAL_HTTPS_LOAD_BALANCER and indicates that connections to the load balancer are being drained. A subnetwork that is draining cannot be used or modified until it reaches a status of READY'

final

subnetworkId → Input<int?>?

The unique identifier number for the resource. This identifier is defined by the server.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toMap() → Map<String, dynamic>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited