Provides a Network resource.
Create Network Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Network(name: string, args: NetworkArgs, opts?: CustomResourceOptions);@overload
def Network(resource_name: str,
args: NetworkArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Network(resource_name: str,
opts: Optional[ResourceOptions] = None,
cidr: Optional[str] = None,
region: Optional[str] = None,
aws_availability_zone_ids: Optional[Sequence[str]] = None,
name: Optional[str] = None,
team_id: Optional[str] = None,
timeouts: Optional[NetworkTimeoutsArgs] = None)func NewNetwork(ctx *Context, name string, args NetworkArgs, opts ...ResourceOption) (*Network, error)public Network(string name, NetworkArgs args, CustomResourceOptions? opts = null)
public Network(String name, NetworkArgs args)
public Network(String name, NetworkArgs args, CustomResourceOptions options)
type: vercel:Network
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args NetworkArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args NetworkArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args NetworkArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args NetworkArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args NetworkArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var networkResource = new Vercel.Network("networkResource", new()
{
Cidr = "string",
Region = "string",
AwsAvailabilityZoneIds = new[]
{
"string",
},
Name = "string",
TeamId = "string",
Timeouts = new Vercel.Inputs.NetworkTimeoutsArgs
{
Create = "string",
},
});
example, err := vercel.NewNetwork(ctx, "networkResource", &vercel.NetworkArgs{
Cidr: pulumi.String("string"),
Region: pulumi.String("string"),
AwsAvailabilityZoneIds: pulumi.StringArray{
pulumi.String("string"),
},
Name: pulumi.String("string"),
TeamId: pulumi.String("string"),
Timeouts: &vercel.NetworkTimeoutsArgs{
Create: pulumi.String("string"),
},
})
var networkResource = new Network("networkResource", NetworkArgs.builder()
.cidr("string")
.region("string")
.awsAvailabilityZoneIds("string")
.name("string")
.teamId("string")
.timeouts(NetworkTimeoutsArgs.builder()
.create("string")
.build())
.build());
network_resource = vercel.Network("networkResource",
cidr="string",
region="string",
aws_availability_zone_ids=["string"],
name="string",
team_id="string",
timeouts={
"create": "string",
})
const networkResource = new vercel.Network("networkResource", {
cidr: "string",
region: "string",
awsAvailabilityZoneIds: ["string"],
name: "string",
teamId: "string",
timeouts: {
create: "string",
},
});
type: vercel:Network
properties:
awsAvailabilityZoneIds:
- string
cidr: string
name: string
region: string
teamId: string
timeouts:
create: string
Network Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Network resource accepts the following input properties:
- Cidr string
- The CIDR range of the Network.
- Region string
- The Vercel region in which the Network exists.
- Aws
Availability List<string>Zone Ids - The IDs of the AWS Availability Zones in which the network exists, if specified during creation.
- Name string
- The name of the network.
- Team
Id string - The unique identifier of the Team that owns the Network. Required when configuring a team resource if a default team has not been set in the provider.
- Timeouts
Pulumiverse.
Vercel. Inputs. Network Timeouts
- Cidr string
- The CIDR range of the Network.
- Region string
- The Vercel region in which the Network exists.
- Aws
Availability []stringZone Ids - The IDs of the AWS Availability Zones in which the network exists, if specified during creation.
- Name string
- The name of the network.
- Team
Id string - The unique identifier of the Team that owns the Network. Required when configuring a team resource if a default team has not been set in the provider.
- Timeouts
Network
Timeouts Args
- cidr String
- The CIDR range of the Network.
- region String
- The Vercel region in which the Network exists.
- aws
Availability List<String>Zone Ids - The IDs of the AWS Availability Zones in which the network exists, if specified during creation.
- name String
- The name of the network.
- team
Id String - The unique identifier of the Team that owns the Network. Required when configuring a team resource if a default team has not been set in the provider.
- timeouts
Network
Timeouts
- cidr string
- The CIDR range of the Network.
- region string
- The Vercel region in which the Network exists.
- aws
Availability string[]Zone Ids - The IDs of the AWS Availability Zones in which the network exists, if specified during creation.
- name string
- The name of the network.
- team
Id string - The unique identifier of the Team that owns the Network. Required when configuring a team resource if a default team has not been set in the provider.
- timeouts
Network
Timeouts
- cidr str
- The CIDR range of the Network.
- region str
- The Vercel region in which the Network exists.
- aws_
availability_ Sequence[str]zone_ ids - The IDs of the AWS Availability Zones in which the network exists, if specified during creation.
- name str
- The name of the network.
- team_
id str - The unique identifier of the Team that owns the Network. Required when configuring a team resource if a default team has not been set in the provider.
- timeouts
Network
Timeouts Args
- cidr String
- The CIDR range of the Network.
- region String
- The Vercel region in which the Network exists.
- aws
Availability List<String>Zone Ids - The IDs of the AWS Availability Zones in which the network exists, if specified during creation.
- name String
- The name of the network.
- team
Id String - The unique identifier of the Team that owns the Network. Required when configuring a team resource if a default team has not been set in the provider.
- timeouts Property Map
Outputs
All input properties are implicitly available as output properties. Additionally, the Network resource produces the following output properties:
- Aws
Account stringId - The ID of the AWS Account in which the network exists.
- Aws
Region string - The AWS Region in which the network exists.
- Egress
Ip List<string>Addresses - The egress IP addresses of the Network.
- Id string
- The provider-assigned unique ID for this managed resource.
- Status string
- The status of the Network.
- Vpc
Id string - The ID of the AWS VPC which hosts the network.
- Aws
Account stringId - The ID of the AWS Account in which the network exists.
- Aws
Region string - The AWS Region in which the network exists.
- Egress
Ip []stringAddresses - The egress IP addresses of the Network.
- Id string
- The provider-assigned unique ID for this managed resource.
- Status string
- The status of the Network.
- Vpc
Id string - The ID of the AWS VPC which hosts the network.
- aws
Account StringId - The ID of the AWS Account in which the network exists.
- aws
Region String - The AWS Region in which the network exists.
- egress
Ip List<String>Addresses - The egress IP addresses of the Network.
- id String
- The provider-assigned unique ID for this managed resource.
- status String
- The status of the Network.
- vpc
Id String - The ID of the AWS VPC which hosts the network.
- aws
Account stringId - The ID of the AWS Account in which the network exists.
- aws
Region string - The AWS Region in which the network exists.
- egress
Ip string[]Addresses - The egress IP addresses of the Network.
- id string
- The provider-assigned unique ID for this managed resource.
- status string
- The status of the Network.
- vpc
Id string - The ID of the AWS VPC which hosts the network.
- aws_
account_ strid - The ID of the AWS Account in which the network exists.
- aws_
region str - The AWS Region in which the network exists.
- egress_
ip_ Sequence[str]addresses - The egress IP addresses of the Network.
- id str
- The provider-assigned unique ID for this managed resource.
- status str
- The status of the Network.
- vpc_
id str - The ID of the AWS VPC which hosts the network.
- aws
Account StringId - The ID of the AWS Account in which the network exists.
- aws
Region String - The AWS Region in which the network exists.
- egress
Ip List<String>Addresses - The egress IP addresses of the Network.
- id String
- The provider-assigned unique ID for this managed resource.
- status String
- The status of the Network.
- vpc
Id String - The ID of the AWS VPC which hosts the network.
Look up Existing Network Resource
Get an existing Network resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: NetworkState, opts?: CustomResourceOptions): Network@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
aws_account_id: Optional[str] = None,
aws_availability_zone_ids: Optional[Sequence[str]] = None,
aws_region: Optional[str] = None,
cidr: Optional[str] = None,
egress_ip_addresses: Optional[Sequence[str]] = None,
name: Optional[str] = None,
region: Optional[str] = None,
status: Optional[str] = None,
team_id: Optional[str] = None,
timeouts: Optional[NetworkTimeoutsArgs] = None,
vpc_id: Optional[str] = None) -> Networkfunc GetNetwork(ctx *Context, name string, id IDInput, state *NetworkState, opts ...ResourceOption) (*Network, error)public static Network Get(string name, Input<string> id, NetworkState? state, CustomResourceOptions? opts = null)public static Network get(String name, Output<String> id, NetworkState state, CustomResourceOptions options)resources: _: type: vercel:Network get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Aws
Account stringId - The ID of the AWS Account in which the network exists.
- Aws
Availability List<string>Zone Ids - The IDs of the AWS Availability Zones in which the network exists, if specified during creation.
- Aws
Region string - The AWS Region in which the network exists.
- Cidr string
- The CIDR range of the Network.
- Egress
Ip List<string>Addresses - The egress IP addresses of the Network.
- Name string
- The name of the network.
- Region string
- The Vercel region in which the Network exists.
- Status string
- The status of the Network.
- Team
Id string - The unique identifier of the Team that owns the Network. Required when configuring a team resource if a default team has not been set in the provider.
- Timeouts
Pulumiverse.
Vercel. Inputs. Network Timeouts - Vpc
Id string - The ID of the AWS VPC which hosts the network.
- Aws
Account stringId - The ID of the AWS Account in which the network exists.
- Aws
Availability []stringZone Ids - The IDs of the AWS Availability Zones in which the network exists, if specified during creation.
- Aws
Region string - The AWS Region in which the network exists.
- Cidr string
- The CIDR range of the Network.
- Egress
Ip []stringAddresses - The egress IP addresses of the Network.
- Name string
- The name of the network.
- Region string
- The Vercel region in which the Network exists.
- Status string
- The status of the Network.
- Team
Id string - The unique identifier of the Team that owns the Network. Required when configuring a team resource if a default team has not been set in the provider.
- Timeouts
Network
Timeouts Args - Vpc
Id string - The ID of the AWS VPC which hosts the network.
- aws
Account StringId - The ID of the AWS Account in which the network exists.
- aws
Availability List<String>Zone Ids - The IDs of the AWS Availability Zones in which the network exists, if specified during creation.
- aws
Region String - The AWS Region in which the network exists.
- cidr String
- The CIDR range of the Network.
- egress
Ip List<String>Addresses - The egress IP addresses of the Network.
- name String
- The name of the network.
- region String
- The Vercel region in which the Network exists.
- status String
- The status of the Network.
- team
Id String - The unique identifier of the Team that owns the Network. Required when configuring a team resource if a default team has not been set in the provider.
- timeouts
Network
Timeouts - vpc
Id String - The ID of the AWS VPC which hosts the network.
- aws
Account stringId - The ID of the AWS Account in which the network exists.
- aws
Availability string[]Zone Ids - The IDs of the AWS Availability Zones in which the network exists, if specified during creation.
- aws
Region string - The AWS Region in which the network exists.
- cidr string
- The CIDR range of the Network.
- egress
Ip string[]Addresses - The egress IP addresses of the Network.
- name string
- The name of the network.
- region string
- The Vercel region in which the Network exists.
- status string
- The status of the Network.
- team
Id string - The unique identifier of the Team that owns the Network. Required when configuring a team resource if a default team has not been set in the provider.
- timeouts
Network
Timeouts - vpc
Id string - The ID of the AWS VPC which hosts the network.
- aws_
account_ strid - The ID of the AWS Account in which the network exists.
- aws_
availability_ Sequence[str]zone_ ids - The IDs of the AWS Availability Zones in which the network exists, if specified during creation.
- aws_
region str - The AWS Region in which the network exists.
- cidr str
- The CIDR range of the Network.
- egress_
ip_ Sequence[str]addresses - The egress IP addresses of the Network.
- name str
- The name of the network.
- region str
- The Vercel region in which the Network exists.
- status str
- The status of the Network.
- team_
id str - The unique identifier of the Team that owns the Network. Required when configuring a team resource if a default team has not been set in the provider.
- timeouts
Network
Timeouts Args - vpc_
id str - The ID of the AWS VPC which hosts the network.
- aws
Account StringId - The ID of the AWS Account in which the network exists.
- aws
Availability List<String>Zone Ids - The IDs of the AWS Availability Zones in which the network exists, if specified during creation.
- aws
Region String - The AWS Region in which the network exists.
- cidr String
- The CIDR range of the Network.
- egress
Ip List<String>Addresses - The egress IP addresses of the Network.
- name String
- The name of the network.
- region String
- The Vercel region in which the Network exists.
- status String
- The status of the Network.
- team
Id String - The unique identifier of the Team that owns the Network. Required when configuring a team resource if a default team has not been set in the provider.
- timeouts Property Map
- vpc
Id String - The ID of the AWS VPC which hosts the network.
Supporting Types
NetworkTimeouts, NetworkTimeoutsArgs
- Create string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- Create string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- create String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- create string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- create str
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- create String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
Package Details
- Repository
- vercel pulumiverse/pulumi-vercel
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
vercelTerraform Provider.
