AddSubnetworkRequest

import type { AddSubnetworkRequest } from "https://googleapis.deno.dev/v1/servicenetworking:v1.ts";

Request to create a subnetwork in a previously peered service network.

interface AddSubnetworkRequest {

allowSubnetCidrRoutesOverlap?: boolean;

checkServiceNetworkingUsePermission?: boolean;

computeIdempotencyWindow?: number;

consumer?: string;

consumerNetwork?: string;

description?: string;

internalRange?: string;

ipPrefixLength?: number;

outsideAllocationPublicIpRange?: string;

privateIpv6GoogleAccess?: string;

purpose?: string;

region?: string;

requestedAddress?: string;

requestedRanges?: string[];

role?: string;

secondaryIpRangeSpecs?: SecondaryIpRangeSpec[];

subnetwork?: string;

subnetworkUsers?: string[];

useCustomComputeIdempotencyWindow?: boolean;

}

§Properties

allowSubnetCidrRoutesOverlap?: boolean

[src]

Optional. Defines the allowSubnetCidrRoutesOverlap field of the subnet, e.g. Available in alpha and beta according to Compute API documentation

checkServiceNetworkingUsePermission?: boolean

[src]

Optional. The IAM permission check determines whether the consumer project has 'servicenetworking.services.use' permission or not.

computeIdempotencyWindow?: number

[src]

Optional. Specifies a custom time bucket for Arcus subnetwork request idempotency. If two equivalent concurrent requests are made, Arcus will know to ignore the request if it has already been completed or is in progress. Only requests with matching compute_idempotency_window have guaranteed idempotency. Changing this time window between requests results in undefined behavior. Zero (or empty) value with custom_compute_idempotency_window=true specifies no idempotency (i.e. no request ID is provided to Arcus). Maximum value of 14 days (enforced by Arcus limit). For more information on how to use, see: go/revisit-sn-idempotency-window

consumer?: string

[src]

Required. A resource that represents the service consumer, such as projects/123456. The project number can be different from the value in the consumer network parameter. For example, the network might be part of a Shared VPC network. In those cases, Service Networking validates that this resource belongs to that Shared VPC.

consumerNetwork?: string

[src]

Required. The name of the service consumer's VPC network. The network must have an existing private connection that was provisioned through the connections.create method. The name must be in the following format: projects/{project}/global/networks/{network}, where {project} is a project number, such as 12345. {network} is the name of a VPC network in the project.

description?: string

[src]

Optional. Description of the subnet.

internalRange?: string

[src]

Optional. The url of an Internal Range. Eg: projects//locations/global/internalRanges/. If specified, it means that the subnetwork cidr will be created using the combination of requested_address/ip_prefix_length. Note that the subnet cidr has to be within the cidr range of this Internal Range.

ipPrefixLength?: number

[src]

Required. The prefix length of the subnet's IP address range. Use CIDR range notation, such as 29 to provision a subnet with an x.x.x.x/29 CIDR range. The IP address range is drawn from a pool of available ranges in the service consumer's allocated range. GCE disallows subnets with prefix_length > 29

outsideAllocationPublicIpRange?: string

[src]

Optional. Enable outside allocation using public IP addresses. Any public IP range may be specified. If this field is provided, we will not use customer reserved ranges for this primary IP range.

privateIpv6GoogleAccess?: string

[src]

Optional. The private IPv6 google access type for the VMs in this subnet. For information about the access types that can be set using this field, see subnetwork in the Compute API documentation.

purpose?: string

[src]

Optional. Defines the purpose field of the subnet, e.g. 'PRIVATE_SERVICE_CONNECT'. For information about the purposes that can be set using this field, see subnetwork in the Compute API documentation.

region?: string

[src]

Required. The name of a region for the subnet, such europe-west1.

requestedAddress?: string

[src]

Optional. The starting address of a range. The address must be a valid IPv4 address in the x.x.x.x format. This value combined with the IP prefix range is the CIDR range for the subnet. The range must be within the allocated range that is assigned to the private connection. If the CIDR range isn't available, the call fails.

requestedRanges?: string[]

[src]

Optional. The name of one or more allocated IP address ranges associated with this private service access connection. If no range names are provided all ranges associated with this connection will be considered. If a CIDR range with the specified IP prefix length is not available within these ranges, the call fails.

role?: string

[src]

Optional. Defines the role field of the subnet, e.g. 'ACTIVE'. For information about the roles that can be set using this field, see subnetwork in the Compute API documentation.

secondaryIpRangeSpecs?: SecondaryIpRangeSpec[]

[src]

Optional. A list of secondary IP ranges to be created within the new subnetwork.

subnetwork?: string

[src]

Required. A name for the new subnet. For information about the naming requirements, see subnetwork in the Compute API documentation.

subnetworkUsers?: string[]

[src]

A list of members that are granted the roles/servicenetworking.subnetworkAdmin role on the subnet.

useCustomComputeIdempotencyWindow?: boolean

[src]

Optional. Specifies if Service Networking should use a custom time bucket for Arcus idempotency. If false, Service Networking uses a 300 second (5 minute) Arcus idempotency window. If true, Service Networking uses a custom idempotency window provided by the user in field compute_idempotency_window. For more information on how to use, see: go/revisit-sn-idempotency-window