nsxt.VpcConnectivityProfile
Explore with Pulumi AI
Create VpcConnectivityProfile Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new VpcConnectivityProfile(name: string, args: VpcConnectivityProfileArgs, opts?: CustomResourceOptions);
@overload
def VpcConnectivityProfile(resource_name: str,
args: VpcConnectivityProfileArgs,
opts: Optional[ResourceOptions] = None)
@overload
def VpcConnectivityProfile(resource_name: str,
opts: Optional[ResourceOptions] = None,
context: Optional[VpcConnectivityProfileContextArgs] = None,
display_name: Optional[str] = None,
transit_gateway_path: Optional[str] = None,
description: Optional[str] = None,
external_ip_blocks: Optional[Sequence[str]] = None,
nsx_id: Optional[str] = None,
private_tgw_ip_blocks: Optional[Sequence[str]] = None,
service_gateway: Optional[VpcConnectivityProfileServiceGatewayArgs] = None,
tags: Optional[Sequence[VpcConnectivityProfileTagArgs]] = None,
vpc_connectivity_profile_id: Optional[str] = None)
func NewVpcConnectivityProfile(ctx *Context, name string, args VpcConnectivityProfileArgs, opts ...ResourceOption) (*VpcConnectivityProfile, error)
public VpcConnectivityProfile(string name, VpcConnectivityProfileArgs args, CustomResourceOptions? opts = null)
public VpcConnectivityProfile(String name, VpcConnectivityProfileArgs args)
public VpcConnectivityProfile(String name, VpcConnectivityProfileArgs args, CustomResourceOptions options)
type: nsxt:VpcConnectivityProfile
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 VpcConnectivityProfileArgs
- 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 VpcConnectivityProfileArgs
- 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 VpcConnectivityProfileArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args VpcConnectivityProfileArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args VpcConnectivityProfileArgs
- 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 vpcConnectivityProfileResource = new Nsxt.VpcConnectivityProfile("vpcConnectivityProfileResource", new()
{
Context = new Nsxt.Inputs.VpcConnectivityProfileContextArgs
{
ProjectId = "string",
},
DisplayName = "string",
TransitGatewayPath = "string",
Description = "string",
ExternalIpBlocks = new[]
{
"string",
},
NsxId = "string",
PrivateTgwIpBlocks = new[]
{
"string",
},
ServiceGateway = new Nsxt.Inputs.VpcConnectivityProfileServiceGatewayArgs
{
EdgeClusterPaths = new[]
{
"string",
},
Enable = false,
NatConfig = new Nsxt.Inputs.VpcConnectivityProfileServiceGatewayNatConfigArgs
{
EnableDefaultSnat = false,
},
QosConfig = new Nsxt.Inputs.VpcConnectivityProfileServiceGatewayQosConfigArgs
{
EgressQosProfilePath = "string",
IngressQosProfilePath = "string",
},
},
Tags = new[]
{
new Nsxt.Inputs.VpcConnectivityProfileTagArgs
{
Scope = "string",
Tag = "string",
},
},
VpcConnectivityProfileId = "string",
});
example, err := nsxt.NewVpcConnectivityProfile(ctx, "vpcConnectivityProfileResource", &nsxt.VpcConnectivityProfileArgs{
Context: &nsxt.VpcConnectivityProfileContextArgs{
ProjectId: pulumi.String("string"),
},
DisplayName: pulumi.String("string"),
TransitGatewayPath: pulumi.String("string"),
Description: pulumi.String("string"),
ExternalIpBlocks: pulumi.StringArray{
pulumi.String("string"),
},
NsxId: pulumi.String("string"),
PrivateTgwIpBlocks: pulumi.StringArray{
pulumi.String("string"),
},
ServiceGateway: &nsxt.VpcConnectivityProfileServiceGatewayArgs{
EdgeClusterPaths: pulumi.StringArray{
pulumi.String("string"),
},
Enable: pulumi.Bool(false),
NatConfig: &nsxt.VpcConnectivityProfileServiceGatewayNatConfigArgs{
EnableDefaultSnat: pulumi.Bool(false),
},
QosConfig: &nsxt.VpcConnectivityProfileServiceGatewayQosConfigArgs{
EgressQosProfilePath: pulumi.String("string"),
IngressQosProfilePath: pulumi.String("string"),
},
},
Tags: nsxt.VpcConnectivityProfileTagArray{
&nsxt.VpcConnectivityProfileTagArgs{
Scope: pulumi.String("string"),
Tag: pulumi.String("string"),
},
},
VpcConnectivityProfileId: pulumi.String("string"),
})
var vpcConnectivityProfileResource = new VpcConnectivityProfile("vpcConnectivityProfileResource", VpcConnectivityProfileArgs.builder()
.context(VpcConnectivityProfileContextArgs.builder()
.projectId("string")
.build())
.displayName("string")
.transitGatewayPath("string")
.description("string")
.externalIpBlocks("string")
.nsxId("string")
.privateTgwIpBlocks("string")
.serviceGateway(VpcConnectivityProfileServiceGatewayArgs.builder()
.edgeClusterPaths("string")
.enable(false)
.natConfig(VpcConnectivityProfileServiceGatewayNatConfigArgs.builder()
.enableDefaultSnat(false)
.build())
.qosConfig(VpcConnectivityProfileServiceGatewayQosConfigArgs.builder()
.egressQosProfilePath("string")
.ingressQosProfilePath("string")
.build())
.build())
.tags(VpcConnectivityProfileTagArgs.builder()
.scope("string")
.tag("string")
.build())
.vpcConnectivityProfileId("string")
.build());
vpc_connectivity_profile_resource = nsxt.VpcConnectivityProfile("vpcConnectivityProfileResource",
context={
"project_id": "string",
},
display_name="string",
transit_gateway_path="string",
description="string",
external_ip_blocks=["string"],
nsx_id="string",
private_tgw_ip_blocks=["string"],
service_gateway={
"edge_cluster_paths": ["string"],
"enable": False,
"nat_config": {
"enable_default_snat": False,
},
"qos_config": {
"egress_qos_profile_path": "string",
"ingress_qos_profile_path": "string",
},
},
tags=[{
"scope": "string",
"tag": "string",
}],
vpc_connectivity_profile_id="string")
const vpcConnectivityProfileResource = new nsxt.VpcConnectivityProfile("vpcConnectivityProfileResource", {
context: {
projectId: "string",
},
displayName: "string",
transitGatewayPath: "string",
description: "string",
externalIpBlocks: ["string"],
nsxId: "string",
privateTgwIpBlocks: ["string"],
serviceGateway: {
edgeClusterPaths: ["string"],
enable: false,
natConfig: {
enableDefaultSnat: false,
},
qosConfig: {
egressQosProfilePath: "string",
ingressQosProfilePath: "string",
},
},
tags: [{
scope: "string",
tag: "string",
}],
vpcConnectivityProfileId: "string",
});
type: nsxt:VpcConnectivityProfile
properties:
context:
projectId: string
description: string
displayName: string
externalIpBlocks:
- string
nsxId: string
privateTgwIpBlocks:
- string
serviceGateway:
edgeClusterPaths:
- string
enable: false
natConfig:
enableDefaultSnat: false
qosConfig:
egressQosProfilePath: string
ingressQosProfilePath: string
tags:
- scope: string
tag: string
transitGatewayPath: string
vpcConnectivityProfileId: string
VpcConnectivityProfile 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 VpcConnectivityProfile resource accepts the following input properties:
- Context
Vpc
Connectivity Profile Context - Resource context
- Display
Name string - Display name of the resource.
- Transit
Gateway stringPath - Transit Gateway path.
- Description string
- Description of the resource.
- External
Ip List<string>Blocks - Policy path of External IP block
- Nsx
Id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- Private
Tgw List<string>Ip Blocks - Policy path of Private IP block
- Service
Gateway VpcConnectivity Profile Service Gateway - Service Gateway configuration
- List<Vpc
Connectivity Profile Tag> - A list of scope + tag pairs to associate with this resource.
- Vpc
Connectivity stringProfile Id - ID of the resource.
- Context
Vpc
Connectivity Profile Context Args - Resource context
- Display
Name string - Display name of the resource.
- Transit
Gateway stringPath - Transit Gateway path.
- Description string
- Description of the resource.
- External
Ip []stringBlocks - Policy path of External IP block
- Nsx
Id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- Private
Tgw []stringIp Blocks - Policy path of Private IP block
- Service
Gateway VpcConnectivity Profile Service Gateway Args - Service Gateway configuration
- []Vpc
Connectivity Profile Tag Args - A list of scope + tag pairs to associate with this resource.
- Vpc
Connectivity stringProfile Id - ID of the resource.
- context
Vpc
Connectivity Profile Context - Resource context
- display
Name String - Display name of the resource.
- transit
Gateway StringPath - Transit Gateway path.
- description String
- Description of the resource.
- external
Ip List<String>Blocks - Policy path of External IP block
- nsx
Id String - The NSX ID of this resource. If set, this ID will be used to create the resource.
- private
Tgw List<String>Ip Blocks - Policy path of Private IP block
- service
Gateway VpcConnectivity Profile Service Gateway - Service Gateway configuration
- List<Vpc
Connectivity Profile Tag> - A list of scope + tag pairs to associate with this resource.
- vpc
Connectivity StringProfile Id - ID of the resource.
- context
Vpc
Connectivity Profile Context - Resource context
- display
Name string - Display name of the resource.
- transit
Gateway stringPath - Transit Gateway path.
- description string
- Description of the resource.
- external
Ip string[]Blocks - Policy path of External IP block
- nsx
Id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- private
Tgw string[]Ip Blocks - Policy path of Private IP block
- service
Gateway VpcConnectivity Profile Service Gateway - Service Gateway configuration
- Vpc
Connectivity Profile Tag[] - A list of scope + tag pairs to associate with this resource.
- vpc
Connectivity stringProfile Id - ID of the resource.
- context
Vpc
Connectivity Profile Context Args - Resource context
- display_
name str - Display name of the resource.
- transit_
gateway_ strpath - Transit Gateway path.
- description str
- Description of the resource.
- external_
ip_ Sequence[str]blocks - Policy path of External IP block
- nsx_
id str - The NSX ID of this resource. If set, this ID will be used to create the resource.
- private_
tgw_ Sequence[str]ip_ blocks - Policy path of Private IP block
- service_
gateway VpcConnectivity Profile Service Gateway Args - Service Gateway configuration
- Sequence[Vpc
Connectivity Profile Tag Args] - A list of scope + tag pairs to associate with this resource.
- vpc_
connectivity_ strprofile_ id - ID of the resource.
- context Property Map
- Resource context
- display
Name String - Display name of the resource.
- transit
Gateway StringPath - Transit Gateway path.
- description String
- Description of the resource.
- external
Ip List<String>Blocks - Policy path of External IP block
- nsx
Id String - The NSX ID of this resource. If set, this ID will be used to create the resource.
- private
Tgw List<String>Ip Blocks - Policy path of Private IP block
- service
Gateway Property Map - Service Gateway configuration
- List<Property Map>
- A list of scope + tag pairs to associate with this resource.
- vpc
Connectivity StringProfile Id - ID of the resource.
Outputs
All input properties are implicitly available as output properties. Additionally, the VpcConnectivityProfile resource produces the following output properties:
Look up Existing VpcConnectivityProfile Resource
Get an existing VpcConnectivityProfile 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?: VpcConnectivityProfileState, opts?: CustomResourceOptions): VpcConnectivityProfile
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
context: Optional[VpcConnectivityProfileContextArgs] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
external_ip_blocks: Optional[Sequence[str]] = None,
nsx_id: Optional[str] = None,
path: Optional[str] = None,
private_tgw_ip_blocks: Optional[Sequence[str]] = None,
revision: Optional[float] = None,
service_gateway: Optional[VpcConnectivityProfileServiceGatewayArgs] = None,
tags: Optional[Sequence[VpcConnectivityProfileTagArgs]] = None,
transit_gateway_path: Optional[str] = None,
vpc_connectivity_profile_id: Optional[str] = None) -> VpcConnectivityProfile
func GetVpcConnectivityProfile(ctx *Context, name string, id IDInput, state *VpcConnectivityProfileState, opts ...ResourceOption) (*VpcConnectivityProfile, error)
public static VpcConnectivityProfile Get(string name, Input<string> id, VpcConnectivityProfileState? state, CustomResourceOptions? opts = null)
public static VpcConnectivityProfile get(String name, Output<String> id, VpcConnectivityProfileState state, CustomResourceOptions options)
resources: _: type: nsxt:VpcConnectivityProfile 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.
- Context
Vpc
Connectivity Profile Context - Resource context
- Description string
- Description of the resource.
- Display
Name string - Display name of the resource.
- External
Ip List<string>Blocks - Policy path of External IP block
- Nsx
Id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- Path string
- The NSX path of the policy resource.
- Private
Tgw List<string>Ip Blocks - Policy path of Private IP block
- Revision double
- Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
- Service
Gateway VpcConnectivity Profile Service Gateway - Service Gateway configuration
- List<Vpc
Connectivity Profile Tag> - A list of scope + tag pairs to associate with this resource.
- Transit
Gateway stringPath - Transit Gateway path.
- Vpc
Connectivity stringProfile Id - ID of the resource.
- Context
Vpc
Connectivity Profile Context Args - Resource context
- Description string
- Description of the resource.
- Display
Name string - Display name of the resource.
- External
Ip []stringBlocks - Policy path of External IP block
- Nsx
Id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- Path string
- The NSX path of the policy resource.
- Private
Tgw []stringIp Blocks - Policy path of Private IP block
- Revision float64
- Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
- Service
Gateway VpcConnectivity Profile Service Gateway Args - Service Gateway configuration
- []Vpc
Connectivity Profile Tag Args - A list of scope + tag pairs to associate with this resource.
- Transit
Gateway stringPath - Transit Gateway path.
- Vpc
Connectivity stringProfile Id - ID of the resource.
- context
Vpc
Connectivity Profile Context - Resource context
- description String
- Description of the resource.
- display
Name String - Display name of the resource.
- external
Ip List<String>Blocks - Policy path of External IP block
- nsx
Id String - The NSX ID of this resource. If set, this ID will be used to create the resource.
- path String
- The NSX path of the policy resource.
- private
Tgw List<String>Ip Blocks - Policy path of Private IP block
- revision Double
- Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
- service
Gateway VpcConnectivity Profile Service Gateway - Service Gateway configuration
- List<Vpc
Connectivity Profile Tag> - A list of scope + tag pairs to associate with this resource.
- transit
Gateway StringPath - Transit Gateway path.
- vpc
Connectivity StringProfile Id - ID of the resource.
- context
Vpc
Connectivity Profile Context - Resource context
- description string
- Description of the resource.
- display
Name string - Display name of the resource.
- external
Ip string[]Blocks - Policy path of External IP block
- nsx
Id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- path string
- The NSX path of the policy resource.
- private
Tgw string[]Ip Blocks - Policy path of Private IP block
- revision number
- Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
- service
Gateway VpcConnectivity Profile Service Gateway - Service Gateway configuration
- Vpc
Connectivity Profile Tag[] - A list of scope + tag pairs to associate with this resource.
- transit
Gateway stringPath - Transit Gateway path.
- vpc
Connectivity stringProfile Id - ID of the resource.
- context
Vpc
Connectivity Profile Context Args - Resource context
- description str
- Description of the resource.
- display_
name str - Display name of the resource.
- external_
ip_ Sequence[str]blocks - Policy path of External IP block
- nsx_
id str - The NSX ID of this resource. If set, this ID will be used to create the resource.
- path str
- The NSX path of the policy resource.
- private_
tgw_ Sequence[str]ip_ blocks - Policy path of Private IP block
- revision float
- Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
- service_
gateway VpcConnectivity Profile Service Gateway Args - Service Gateway configuration
- Sequence[Vpc
Connectivity Profile Tag Args] - A list of scope + tag pairs to associate with this resource.
- transit_
gateway_ strpath - Transit Gateway path.
- vpc_
connectivity_ strprofile_ id - ID of the resource.
- context Property Map
- Resource context
- description String
- Description of the resource.
- display
Name String - Display name of the resource.
- external
Ip List<String>Blocks - Policy path of External IP block
- nsx
Id String - The NSX ID of this resource. If set, this ID will be used to create the resource.
- path String
- The NSX path of the policy resource.
- private
Tgw List<String>Ip Blocks - Policy path of Private IP block
- revision Number
- Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
- service
Gateway Property Map - Service Gateway configuration
- List<Property Map>
- A list of scope + tag pairs to associate with this resource.
- transit
Gateway StringPath - Transit Gateway path.
- vpc
Connectivity StringProfile Id - ID of the resource.
Supporting Types
VpcConnectivityProfileContext, VpcConnectivityProfileContextArgs
- Project
Id string - Id of the project which the resource belongs to.
- Project
Id string - Id of the project which the resource belongs to.
- project
Id String - Id of the project which the resource belongs to.
- project
Id string - Id of the project which the resource belongs to.
- project_
id str - Id of the project which the resource belongs to.
- project
Id String - Id of the project which the resource belongs to.
VpcConnectivityProfileServiceGateway, VpcConnectivityProfileServiceGatewayArgs
- Edge
Cluster List<string>Paths - List of edge cluster paths for VPC attachment SR realization. If edge cluster is not specified transit gateway's edge cluster will be used.
- Enable bool
- Status of the VPC attachment SR.
- Nat
Config VpcConnectivity Profile Service Gateway Nat Config - NAT configuration
- Qos
Config VpcConnectivity Profile Service Gateway Qos Config - None
- Edge
Cluster []stringPaths - List of edge cluster paths for VPC attachment SR realization. If edge cluster is not specified transit gateway's edge cluster will be used.
- Enable bool
- Status of the VPC attachment SR.
- Nat
Config VpcConnectivity Profile Service Gateway Nat Config - NAT configuration
- Qos
Config VpcConnectivity Profile Service Gateway Qos Config - None
- edge
Cluster List<String>Paths - List of edge cluster paths for VPC attachment SR realization. If edge cluster is not specified transit gateway's edge cluster will be used.
- enable Boolean
- Status of the VPC attachment SR.
- nat
Config VpcConnectivity Profile Service Gateway Nat Config - NAT configuration
- qos
Config VpcConnectivity Profile Service Gateway Qos Config - None
- edge
Cluster string[]Paths - List of edge cluster paths for VPC attachment SR realization. If edge cluster is not specified transit gateway's edge cluster will be used.
- enable boolean
- Status of the VPC attachment SR.
- nat
Config VpcConnectivity Profile Service Gateway Nat Config - NAT configuration
- qos
Config VpcConnectivity Profile Service Gateway Qos Config - None
- edge_
cluster_ Sequence[str]paths - List of edge cluster paths for VPC attachment SR realization. If edge cluster is not specified transit gateway's edge cluster will be used.
- enable bool
- Status of the VPC attachment SR.
- nat_
config VpcConnectivity Profile Service Gateway Nat Config - NAT configuration
- qos_
config VpcConnectivity Profile Service Gateway Qos Config - None
- edge
Cluster List<String>Paths - List of edge cluster paths for VPC attachment SR realization. If edge cluster is not specified transit gateway's edge cluster will be used.
- enable Boolean
- Status of the VPC attachment SR.
- nat
Config Property Map - NAT configuration
- qos
Config Property Map - None
VpcConnectivityProfileServiceGatewayNatConfig, VpcConnectivityProfileServiceGatewayNatConfigArgs
- Enable
Default boolSnat - Auto configured SNAT for private subnet.
- Enable
Default boolSnat - Auto configured SNAT for private subnet.
- enable
Default BooleanSnat - Auto configured SNAT for private subnet.
- enable
Default booleanSnat - Auto configured SNAT for private subnet.
- enable_
default_ boolsnat - Auto configured SNAT for private subnet.
- enable
Default BooleanSnat - Auto configured SNAT for private subnet.
VpcConnectivityProfileServiceGatewayQosConfig, VpcConnectivityProfileServiceGatewayQosConfigArgs
- Egress
Qos stringProfile Path - Policy path to gateway QoS profile in egress direction.
- Ingress
Qos stringProfile Path - Policy path to gateway QoS profile in ingress direction.
- Egress
Qos stringProfile Path - Policy path to gateway QoS profile in egress direction.
- Ingress
Qos stringProfile Path - Policy path to gateway QoS profile in ingress direction.
- egress
Qos StringProfile Path - Policy path to gateway QoS profile in egress direction.
- ingress
Qos StringProfile Path - Policy path to gateway QoS profile in ingress direction.
- egress
Qos stringProfile Path - Policy path to gateway QoS profile in egress direction.
- ingress
Qos stringProfile Path - Policy path to gateway QoS profile in ingress direction.
- egress_
qos_ strprofile_ path - Policy path to gateway QoS profile in egress direction.
- ingress_
qos_ strprofile_ path - Policy path to gateway QoS profile in ingress direction.
- egress
Qos StringProfile Path - Policy path to gateway QoS profile in egress direction.
- ingress
Qos StringProfile Path - Policy path to gateway QoS profile in ingress direction.
VpcConnectivityProfileTag, VpcConnectivityProfileTagArgs
Package Details
- Repository
- nsxt vmware/terraform-provider-nsxt
- License
- Notes
- This Pulumi package is based on the
nsxt
Terraform Provider.