AddressArgs class
The set of arguments for Address. The set of arguments for Address.
Constructors
-
AddressArgs({Input<
String?> ? address, Input<String?> ? addressType, Input<String?> ? deletionPolicy, Input<String?> ? description, Input<String?> ? ipCollection, Input<String?> ? ipVersion, Input<String?> ? ipv6EndpointType, Input<Map< ? labels, Input<String, String> ?>String?> ? name, Input<String?> ? network, Input<String?> ? networkTier, Input<int?> ? prefixLength, Input<String?> ? project, Input<String?> ? purpose, Input<String?> ? region, Input<String?> ? subnetwork}) -
Creates a new AddressArgs.
addressThe static external IP address represented by this resource.addressTypeThe type of address to reserve.deletionPolicyWhether Terraform will be prevented from destroying the resource. Defaults to DELETE.descriptionAn optional description of this resource.ipCollectionReference to the source of external IPv4/IPv6 addresses, like a PublicDelegatedPrefix(PDP) for BYOIP.ipVersionThe IP Version that will be used by this address. The default value isIPV4.ipv6EndpointTypeThe endpoint type of this address, which should be VM or NETLB. This islabelsLabels to apply to this address. A list of key->value pairs.nameName of the resource. The name must be 1-63 characters long, andnetworkThe URL of the network in which to reserve the address. This fieldnetworkTierThe networking tier used for configuring this address. If this field is notprefixLengthThe prefix length if the resource represents an IP range.projectThe ID of the project in which the resource belongs.purposeThe purpose of this resource, which can be one of the following values.regionThe Region in which the created address should reside.subnetworkThe URL of the subnetwork in which to reserve the address. If an IPconst -
AddressArgs.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
address
→ Input<
String?> ? -
The static external IP address represented by this resource.
The IP address must be inside the specified subnetwork,
if any. Set by the API if undefined.
final
-
addressType
→ Input<
String?> ? -
The type of address to reserve.
Note: if you set this argument's value as
INTERNALyou need to leave thenetworkTierargument unset in that resource block. Default value isEXTERNAL. Possible values are:INTERNAL,EXTERNAL.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
- hashCode → int
-
The hash code for this object.
no setterinherited
-
ipCollection
→ Input<
String?> ? -
Reference to the source of external IPv4/IPv6 addresses, like a PublicDelegatedPrefix(PDP) for BYOIP.
If an IPv4 PDP is used, the PDP must support enhanced IPv4 allocations.
If an IPv6 PDP is used, the PDP must be in EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode.
Use one of the following formats to specify a PDP when reserving an external IPv4 address using BYOIP.
Full resource URL, as in:
final
-
ipv6EndpointType
→ Input<
String?> ? -
The endpoint type of this address, which should be VM or NETLB. This is
used for deciding which type of endpoint this address can be used after
the external IPv6 address reservation.
Possible values are:
VM,NETLB.final -
ipVersion
→ Input<
String?> ? -
The IP Version that will be used by this address. The default value is
IPV4. Possible values are:IPV4,IPV6.final -
labels
→ Input<
Map< ?String, String> ?> -
Labels to apply to this address. A list of key->value pairs.
final
-
name
→ Input<
String?> ? -
Name of 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 URL of the network in which to reserve the address. This field
can only be used with INTERNAL type with the VPC_PEERING and
IPSEC_INTERCONNECT purposes.
final
-
networkTier
→ Input<
String?> ? -
The networking tier used for configuring this address. If this field is not
specified, it is assumed to be PREMIUM.
This argument should not be used when configuring Internal addresses, because network tier cannot be set for internal traffic; it's always Premium.
Possible values are:
PREMIUM,STANDARD.final -
prefixLength
→ Input<
int?> ? -
The prefix length if the resource represents an IP range.
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 this resource, which can be one of the following values.
final
-
region
→ Input<
String?> ? -
The Region in which the created address should reside.
If it is not provided, the provider region is used.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
subnetwork
→ Input<
String?> ? -
The URL of the subnetwork in which to reserve the address. If an IP
address is specified, it must be within the subnetwork's IP range.
This field can only be used with INTERNAL type with
GCE_ENDPOINT/DNS_RESOLVER purposes.
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