1. Packages
  2. Vcd Provider
  3. API Docs
  4. NsxtEdgegatewayRateLimiting
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware

vcd.NsxtEdgegatewayRateLimiting

Explore with Pulumi AI

vcd logo
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware

    Create NsxtEdgegatewayRateLimiting Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new NsxtEdgegatewayRateLimiting(name: string, args: NsxtEdgegatewayRateLimitingArgs, opts?: CustomResourceOptions);
    @overload
    def NsxtEdgegatewayRateLimiting(resource_name: str,
                                    args: NsxtEdgegatewayRateLimitingArgs,
                                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def NsxtEdgegatewayRateLimiting(resource_name: str,
                                    opts: Optional[ResourceOptions] = None,
                                    edge_gateway_id: Optional[str] = None,
                                    egress_profile_id: Optional[str] = None,
                                    ingress_profile_id: Optional[str] = None,
                                    nsxt_edgegateway_rate_limiting_id: Optional[str] = None,
                                    org: Optional[str] = None)
    func NewNsxtEdgegatewayRateLimiting(ctx *Context, name string, args NsxtEdgegatewayRateLimitingArgs, opts ...ResourceOption) (*NsxtEdgegatewayRateLimiting, error)
    public NsxtEdgegatewayRateLimiting(string name, NsxtEdgegatewayRateLimitingArgs args, CustomResourceOptions? opts = null)
    public NsxtEdgegatewayRateLimiting(String name, NsxtEdgegatewayRateLimitingArgs args)
    public NsxtEdgegatewayRateLimiting(String name, NsxtEdgegatewayRateLimitingArgs args, CustomResourceOptions options)
    
    type: vcd:NsxtEdgegatewayRateLimiting
    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 NsxtEdgegatewayRateLimitingArgs
    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 NsxtEdgegatewayRateLimitingArgs
    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 NsxtEdgegatewayRateLimitingArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NsxtEdgegatewayRateLimitingArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NsxtEdgegatewayRateLimitingArgs
    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 nsxtEdgegatewayRateLimitingResource = new Vcd.NsxtEdgegatewayRateLimiting("nsxtEdgegatewayRateLimitingResource", new()
    {
        EdgeGatewayId = "string",
        EgressProfileId = "string",
        IngressProfileId = "string",
        NsxtEdgegatewayRateLimitingId = "string",
        Org = "string",
    });
    
    example, err := vcd.NewNsxtEdgegatewayRateLimiting(ctx, "nsxtEdgegatewayRateLimitingResource", &vcd.NsxtEdgegatewayRateLimitingArgs{
    	EdgeGatewayId:                 pulumi.String("string"),
    	EgressProfileId:               pulumi.String("string"),
    	IngressProfileId:              pulumi.String("string"),
    	NsxtEdgegatewayRateLimitingId: pulumi.String("string"),
    	Org:                           pulumi.String("string"),
    })
    
    var nsxtEdgegatewayRateLimitingResource = new NsxtEdgegatewayRateLimiting("nsxtEdgegatewayRateLimitingResource", NsxtEdgegatewayRateLimitingArgs.builder()
        .edgeGatewayId("string")
        .egressProfileId("string")
        .ingressProfileId("string")
        .nsxtEdgegatewayRateLimitingId("string")
        .org("string")
        .build());
    
    nsxt_edgegateway_rate_limiting_resource = vcd.NsxtEdgegatewayRateLimiting("nsxtEdgegatewayRateLimitingResource",
        edge_gateway_id="string",
        egress_profile_id="string",
        ingress_profile_id="string",
        nsxt_edgegateway_rate_limiting_id="string",
        org="string")
    
    const nsxtEdgegatewayRateLimitingResource = new vcd.NsxtEdgegatewayRateLimiting("nsxtEdgegatewayRateLimitingResource", {
        edgeGatewayId: "string",
        egressProfileId: "string",
        ingressProfileId: "string",
        nsxtEdgegatewayRateLimitingId: "string",
        org: "string",
    });
    
    type: vcd:NsxtEdgegatewayRateLimiting
    properties:
        edgeGatewayId: string
        egressProfileId: string
        ingressProfileId: string
        nsxtEdgegatewayRateLimitingId: string
        org: string
    

    NsxtEdgegatewayRateLimiting 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 NsxtEdgegatewayRateLimiting resource accepts the following input properties:

    EdgeGatewayId string
    NSX-T Edge Gateway ID
    EgressProfileId string

    A QoS profile to apply for egress traffic. Note leaving empty means unlimited.

    Ingress and Egress profile IDs can be looked up using vcd.getNsxtEdgegatewayQosProfile data source.

    IngressProfileId string
    A QoS profile to apply for ingress traffic. Note leaving empty means unlimited.
    NsxtEdgegatewayRateLimitingId string
    Org string
    Org in which the NSX-T Edge Gateway is located
    EdgeGatewayId string
    NSX-T Edge Gateway ID
    EgressProfileId string

    A QoS profile to apply for egress traffic. Note leaving empty means unlimited.

    Ingress and Egress profile IDs can be looked up using vcd.getNsxtEdgegatewayQosProfile data source.

    IngressProfileId string
    A QoS profile to apply for ingress traffic. Note leaving empty means unlimited.
    NsxtEdgegatewayRateLimitingId string
    Org string
    Org in which the NSX-T Edge Gateway is located
    edgeGatewayId String
    NSX-T Edge Gateway ID
    egressProfileId String

    A QoS profile to apply for egress traffic. Note leaving empty means unlimited.

    Ingress and Egress profile IDs can be looked up using vcd.getNsxtEdgegatewayQosProfile data source.

    ingressProfileId String
    A QoS profile to apply for ingress traffic. Note leaving empty means unlimited.
    nsxtEdgegatewayRateLimitingId String
    org String
    Org in which the NSX-T Edge Gateway is located
    edgeGatewayId string
    NSX-T Edge Gateway ID
    egressProfileId string

    A QoS profile to apply for egress traffic. Note leaving empty means unlimited.

    Ingress and Egress profile IDs can be looked up using vcd.getNsxtEdgegatewayQosProfile data source.

    ingressProfileId string
    A QoS profile to apply for ingress traffic. Note leaving empty means unlimited.
    nsxtEdgegatewayRateLimitingId string
    org string
    Org in which the NSX-T Edge Gateway is located
    edge_gateway_id str
    NSX-T Edge Gateway ID
    egress_profile_id str

    A QoS profile to apply for egress traffic. Note leaving empty means unlimited.

    Ingress and Egress profile IDs can be looked up using vcd.getNsxtEdgegatewayQosProfile data source.

    ingress_profile_id str
    A QoS profile to apply for ingress traffic. Note leaving empty means unlimited.
    nsxt_edgegateway_rate_limiting_id str
    org str
    Org in which the NSX-T Edge Gateway is located
    edgeGatewayId String
    NSX-T Edge Gateway ID
    egressProfileId String

    A QoS profile to apply for egress traffic. Note leaving empty means unlimited.

    Ingress and Egress profile IDs can be looked up using vcd.getNsxtEdgegatewayQosProfile data source.

    ingressProfileId String
    A QoS profile to apply for ingress traffic. Note leaving empty means unlimited.
    nsxtEdgegatewayRateLimitingId String
    org String
    Org in which the NSX-T Edge Gateway is located

    Outputs

    All input properties are implicitly available as output properties. Additionally, the NsxtEdgegatewayRateLimiting resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing NsxtEdgegatewayRateLimiting Resource

    Get an existing NsxtEdgegatewayRateLimiting 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?: NsxtEdgegatewayRateLimitingState, opts?: CustomResourceOptions): NsxtEdgegatewayRateLimiting
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            edge_gateway_id: Optional[str] = None,
            egress_profile_id: Optional[str] = None,
            ingress_profile_id: Optional[str] = None,
            nsxt_edgegateway_rate_limiting_id: Optional[str] = None,
            org: Optional[str] = None) -> NsxtEdgegatewayRateLimiting
    func GetNsxtEdgegatewayRateLimiting(ctx *Context, name string, id IDInput, state *NsxtEdgegatewayRateLimitingState, opts ...ResourceOption) (*NsxtEdgegatewayRateLimiting, error)
    public static NsxtEdgegatewayRateLimiting Get(string name, Input<string> id, NsxtEdgegatewayRateLimitingState? state, CustomResourceOptions? opts = null)
    public static NsxtEdgegatewayRateLimiting get(String name, Output<String> id, NsxtEdgegatewayRateLimitingState state, CustomResourceOptions options)
    resources:  _:    type: vcd:NsxtEdgegatewayRateLimiting    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.
    The following state arguments are supported:
    EdgeGatewayId string
    NSX-T Edge Gateway ID
    EgressProfileId string

    A QoS profile to apply for egress traffic. Note leaving empty means unlimited.

    Ingress and Egress profile IDs can be looked up using vcd.getNsxtEdgegatewayQosProfile data source.

    IngressProfileId string
    A QoS profile to apply for ingress traffic. Note leaving empty means unlimited.
    NsxtEdgegatewayRateLimitingId string
    Org string
    Org in which the NSX-T Edge Gateway is located
    EdgeGatewayId string
    NSX-T Edge Gateway ID
    EgressProfileId string

    A QoS profile to apply for egress traffic. Note leaving empty means unlimited.

    Ingress and Egress profile IDs can be looked up using vcd.getNsxtEdgegatewayQosProfile data source.

    IngressProfileId string
    A QoS profile to apply for ingress traffic. Note leaving empty means unlimited.
    NsxtEdgegatewayRateLimitingId string
    Org string
    Org in which the NSX-T Edge Gateway is located
    edgeGatewayId String
    NSX-T Edge Gateway ID
    egressProfileId String

    A QoS profile to apply for egress traffic. Note leaving empty means unlimited.

    Ingress and Egress profile IDs can be looked up using vcd.getNsxtEdgegatewayQosProfile data source.

    ingressProfileId String
    A QoS profile to apply for ingress traffic. Note leaving empty means unlimited.
    nsxtEdgegatewayRateLimitingId String
    org String
    Org in which the NSX-T Edge Gateway is located
    edgeGatewayId string
    NSX-T Edge Gateway ID
    egressProfileId string

    A QoS profile to apply for egress traffic. Note leaving empty means unlimited.

    Ingress and Egress profile IDs can be looked up using vcd.getNsxtEdgegatewayQosProfile data source.

    ingressProfileId string
    A QoS profile to apply for ingress traffic. Note leaving empty means unlimited.
    nsxtEdgegatewayRateLimitingId string
    org string
    Org in which the NSX-T Edge Gateway is located
    edge_gateway_id str
    NSX-T Edge Gateway ID
    egress_profile_id str

    A QoS profile to apply for egress traffic. Note leaving empty means unlimited.

    Ingress and Egress profile IDs can be looked up using vcd.getNsxtEdgegatewayQosProfile data source.

    ingress_profile_id str
    A QoS profile to apply for ingress traffic. Note leaving empty means unlimited.
    nsxt_edgegateway_rate_limiting_id str
    org str
    Org in which the NSX-T Edge Gateway is located
    edgeGatewayId String
    NSX-T Edge Gateway ID
    egressProfileId String

    A QoS profile to apply for egress traffic. Note leaving empty means unlimited.

    Ingress and Egress profile IDs can be looked up using vcd.getNsxtEdgegatewayQosProfile data source.

    ingressProfileId String
    A QoS profile to apply for ingress traffic. Note leaving empty means unlimited.
    nsxtEdgegatewayRateLimitingId String
    org String
    Org in which the NSX-T Edge Gateway is located

    Package Details

    Repository
    vcd vmware/terraform-provider-vcd
    License
    Notes
    This Pulumi package is based on the vcd Terraform Provider.
    vcd logo
    vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware