RouterNatAddress class

A resource used to set the list of IP addresses to be used in a NAT service and manage the draining of destroyed IPs.

> Note: This resource is to be used alongside a gcp.compute.RouterNat resource, the router nat resource must have no defined natIps or drainNatIps parameters, instead using the initialNatIps parameter to set at least one IP for the creation of the resource.

To get more information about RouterNatAddress, see:

Example Usage

Import

RouterNatAddress can be imported using any of these accepted formats:

projects/{{project}}/regions/{{region}}/routers/{{router}}/{{router_nat}}
{{project}}/{{region}}/{{router}}/{{router_nat}}
{{region}}/{{router}}/{{router_nat}}
{{router}}/{{router_nat}}

When using the pulumi import command, RouterNatAddress can be imported using one of the formats above. For example:

$ pulumi import gcp:compute/routerNatAddress:RouterNatAddress default projects/{{project}}/regions/{{region}}/routers/{{router}}/{{router_nat}}
$ pulumi import gcp:compute/routerNatAddress:RouterNatAddress default {{project}}/{{region}}/{{router}}/{{router_nat}}
$ pulumi import gcp:compute/routerNatAddress:RouterNatAddress default {{region}}/{{router}}/{{router_nat}}
$ pulumi import gcp:compute/routerNatAddress:RouterNatAddress default {{router}}/{{router_nat}}

Constructors

RouterNatAddress(String name, {RouterNatAddressArgs? args, CustomResourceOptions? options}): Creates a new RouterNatAddress. name The Pulumi resource name. args Arguments used to configure this RouterNatAddress. The set of arguments for RouterNatAddress. options Resource options controlling this resource's behavior.
RouterNatAddress.reference(String urn): Creates a typed reference to an existing RouterNatAddress resource.

Properties

childResources → Set<Resource>: finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>: latefinalinherited
deletionPolicy ↔ Output<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.
latefinal
drainNatIps ↔ Output<List<String>?>: A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT.
latefinal
hashCode → int: The hash code for this object.
no setterinherited
id ↔ Output<String>: getter/setter pairinherited
isCustom → bool: Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool: Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool: Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool: Whether this instance represents a resource value returned over RPC.
finalinherited
natIps ↔ Output<List<String>>: Self-links of NAT IPs to be used in a Nat service. Only valid if the referenced RouterNat natIpAllocateOption is set to MANUAL_ONLY.
latefinal
project ↔ Output<String>: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
latefinal
region ↔ Output<String>: Region where the NAT service reside.
latefinal
resourceTransforms → List<ResourceTransform>: Inherited/explicit async transforms.
no setterinherited
router ↔ Output<String>: The name of the Cloud Router in which the referenced NAT service is configured.
latefinal
routerNat ↔ Output<String>: The name of the Nat service in which this address will be configured.
latefinal
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
transformations → List<ResourceTransformation>: Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>: latefinalinherited

Methods

failId(Object error) → void: Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void: Completes all output properties with error.
inherited
failUrn(Object error) → void: Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?: Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String: Returns this resource's logical name.
inherited
getResourceType() → String: Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>: Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void: Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void: Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void: Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>: Serializes resource properties for RPC transmission.
inherited
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {RouterNatAddressState? state, CustomResourceOptions? options}) → RouterNatAddress: Gets an existing RouterNatAddress resource's state with the given name and id.