InternalRangeState class
Input properties used for looking up and filtering InternalRange resources.
Constructors
-
InternalRangeState({Input<
InternalRangeAllocationOptions?> ? allocationOptions, Input<String?> ? deletionPolicy, Input<String?> ? description, Input<Map< ? effectiveLabels, Input<String, String> ?>List< ? excludeCidrRanges, Input<String> ?>bool?> ? immutable, Input<String?> ? ipCidrRange, Input<Map< ? labels, Input<String, String> ?>InternalRangeMigration?> ? migration, Input<String?> ? name, Input<String?> ? network, Input<List< ? overlaps, Input<String> ?>String?> ? peering, Input<int?> ? prefixLength, Input<String?> ? project, Input<Map< ? pulumiLabels, Input<String, String> ?>List< ? targetCidrRanges, Input<String> ?>String?> ? usage, Input<List< ? users})String> ?> -
Creates a new InternalRangeState.
allocationOptionsOptions for automatically allocating a free range with a size given by prefixLength.deletionPolicyWhether Terraform will be prevented from destroying the resource. Defaults to DELETE.descriptionAn optional description of this resource.effectiveLabelsAll of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.excludeCidrRangesOptional. List of IP CIDR ranges to be excluded. Resulting reserved Internal Range will not overlap with any CIDR blocks mentioned in this list.immutableImmutable ranges cannot have their fields modified, except for labels and description.ipCidrRangeThe IP range that this internal range defines.labelsUser-defined labels.migrationSpecification for migration with source and target resource names.nameThe name of the policy based route.networkFully-qualified URL of the network that this route applies to, for example: projects/my-project/global/networks/my-network.overlapsOptional. Types of resources that are allowed to overlap with the current internal range.peeringThe type of peering set for this internal range.prefixLengthAn alternate to ipCidrRange. Can be set when trying to create a reservation that automatically finds a free range of the given size.projectThe ID of the project in which the resource belongs.pulumiLabelsThe combination of labels configured directly on the resourcetargetCidrRangesOptional. Can be set to narrow down or pick a different address space while searching for a free range.usageThe type of usage set for this InternalRange.usersOutput only. The list of resources that refer to this internal range.const -
InternalRangeState.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
allocationOptions
→ Input<
InternalRangeAllocationOptions?> ? -
Options for automatically allocating a free range with a size given by prefixLength.
Structure is documented below.
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.
final
-
effectiveLabels
→ Input<
Map< ?String, String> ?> -
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
final
-
excludeCidrRanges
→ Input<
List< ?String> ?> -
Optional. List of IP CIDR ranges to be excluded. Resulting reserved Internal Range will not overlap with any CIDR blocks mentioned in this list.
Only IPv4 CIDR ranges are supported.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
immutable
→ Input<
bool?> ? -
Immutable ranges cannot have their fields modified, except for labels and description.
final
-
ipCidrRange
→ Input<
String?> ? -
The IP range that this internal range defines.
NOTE: IPv6 ranges are limited to usage=EXTERNAL_TO_VPC and peering=FOR_SELF
NOTE: For IPv6 Ranges this field is compulsory, i.e. the address range must be specified explicitly.
final
-
labels
→ Input<
Map< ?String, String> ?> -
User-defined labels.
final
-
migration
→ Input<
InternalRangeMigration?> ? -
Specification for migration with source and target resource names.
Structure is documented below.
final
-
name
→ Input<
String?> ? -
The name of the policy based route.
final
-
network
→ Input<
String?> ? -
Fully-qualified URL of the network that this route applies to, for example: projects/my-project/global/networks/my-network.
final
-
overlaps
→ Input<
List< ?String> ?> -
Optional. Types of resources that are allowed to overlap with the current internal range.
Each value may be one of:
OVERLAP_ROUTE_RANGE,OVERLAP_EXISTING_SUBNET_RANGE.final -
peering
→ Input<
String?> ? -
The type of peering set for this internal range.
Possible values are:
FOR_SELF,FOR_PEER,NOT_SHARED.final -
prefixLength
→ Input<
int?> ? -
An alternate to ipCidrRange. Can be set when trying to create a reservation that automatically finds a free range of the given size.
If both ipCidrRange and prefixLength are set, there is an error if the range sizes do not match. Can also be used during updates to change the range size.
NOTE: For IPv6 this field only works if ipCidrRange is set as well, and both fields must match. In other words, with IPv6 this field only works as
a redundant parameter.
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
-
pulumiLabels
→ Input<
Map< ?String, String> ?> -
The combination of labels configured directly on the resource
and default labels configured on the provider.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
targetCidrRanges
→ Input<
List< ?String> ?> -
Optional. Can be set to narrow down or pick a different address space while searching for a free range.
If not set, defaults to the "10.0.0.0/8" address space. This can be used to search in other rfc-1918 address spaces like "172.16.0.0/12" and "192.168.0.0/16" or non-rfc-1918 address spaces used in the VPC.
final
-
usage
→ Input<
String?> ? -
The type of usage set for this InternalRange.
Possible values are:
FOR_VPC,EXTERNAL_TO_VPC,FOR_MIGRATION.final -
users
→ Input<
List< ?String> ?> -
Output only. The list of resources that refer to this internal range.
Resources that use the internal range for their range allocation are referred to as users of the range.
Other resources mark themselves as users while doing so by creating a reference to this internal range. Having a user, based on this reference, prevents deletion of the internal range referred to. Can be empty.
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