Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vcd Provider
  3. API Docs
  4. ApiFilter
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-vcd

vcd.ApiFilter

Explore with Pulumi AI

vcd logo
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-vcd

    Create ApiFilter Resource

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

    Constructor syntax

    new ApiFilter(name: string, args: ApiFilterArgs, opts?: CustomResourceOptions);
    @overload
def ApiFilter(resource_name: str,
              args: ApiFilterArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def ApiFilter(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              external_endpoint_id: Optional[str] = None,
              url_matcher_pattern: Optional[str] = None,
              url_matcher_scope: Optional[str] = None,
              api_filter_id: Optional[str] = None)
    func NewApiFilter(ctx *Context, name string, args ApiFilterArgs, opts ...ResourceOption) (*ApiFilter, error)
    public ApiFilter(string name, ApiFilterArgs args, CustomResourceOptions? opts = null)
    public ApiFilter(String name, ApiFilterArgs args)
public ApiFilter(String name, ApiFilterArgs args, CustomResourceOptions options)

    type: vcd:ApiFilter
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 ApiFilterArgs
    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 ApiFilterArgs
    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 ApiFilterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApiFilterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApiFilterArgs
    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 apiFilterResource = new Vcd.ApiFilter("apiFilterResource", new()
{
    ExternalEndpointId = "string",
    UrlMatcherPattern = "string",
    UrlMatcherScope = "string",
    ApiFilterId = "string",
});

    example, err := vcd.NewApiFilter(ctx, "apiFilterResource", &vcd.ApiFilterArgs{
	ExternalEndpointId: pulumi.String("string"),
	UrlMatcherPattern:  pulumi.String("string"),
	UrlMatcherScope:    pulumi.String("string"),
	ApiFilterId:        pulumi.String("string"),
})

    var apiFilterResource = new ApiFilter("apiFilterResource", ApiFilterArgs.builder()
    .externalEndpointId("string")
    .urlMatcherPattern("string")
    .urlMatcherScope("string")
    .apiFilterId("string")
    .build());

    api_filter_resource = vcd.ApiFilter("apiFilterResource",
    external_endpoint_id="string",
    url_matcher_pattern="string",
    url_matcher_scope="string",
    api_filter_id="string")

    const apiFilterResource = new vcd.ApiFilter("apiFilterResource", {
    externalEndpointId: "string",
    urlMatcherPattern: "string",
    urlMatcherScope: "string",
    apiFilterId: "string",
});

    type: vcd:ApiFilter
properties:
    apiFilterId: string
    externalEndpointId: string
    urlMatcherPattern: string
    urlMatcherScope: string

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

    ExternalEndpointId string
    ID of the External Endpoint where this API Filter will process the requests to
    UrlMatcherPattern string
    Request URL pattern, written as a regular expression. This argument cannot exceed 1024 characters. In most cases, it should end with .* (it is like a suffix) which specifies that all the parts of the URL coming after (like parameters) will be redirected to an external endpoint. It is important to note that in the case of url_matcher_scope=EXT_UI_TENANT, the tenant name is not part of the pattern, it will match the request after the tenant name - if request is "/ext-ui/tenant/testOrg/custom/test", the pattern will match against /custom/test
    UrlMatcherScope string
    Allowed values are EXT_API, EXT_UI_PROVIDER, EXT_UI_TENANT corresponding to /ext-api, /ext-ui/provider, /ext-ui/tenant/
    ApiFilterId string
    ExternalEndpointId string
    ID of the External Endpoint where this API Filter will process the requests to
    UrlMatcherPattern string
    Request URL pattern, written as a regular expression. This argument cannot exceed 1024 characters. In most cases, it should end with .* (it is like a suffix) which specifies that all the parts of the URL coming after (like parameters) will be redirected to an external endpoint. It is important to note that in the case of url_matcher_scope=EXT_UI_TENANT, the tenant name is not part of the pattern, it will match the request after the tenant name - if request is "/ext-ui/tenant/testOrg/custom/test", the pattern will match against /custom/test
    UrlMatcherScope string
    Allowed values are EXT_API, EXT_UI_PROVIDER, EXT_UI_TENANT corresponding to /ext-api, /ext-ui/provider, /ext-ui/tenant/
    ApiFilterId string
    externalEndpointId String
    ID of the External Endpoint where this API Filter will process the requests to
    urlMatcherPattern String
    Request URL pattern, written as a regular expression. This argument cannot exceed 1024 characters. In most cases, it should end with .* (it is like a suffix) which specifies that all the parts of the URL coming after (like parameters) will be redirected to an external endpoint. It is important to note that in the case of url_matcher_scope=EXT_UI_TENANT, the tenant name is not part of the pattern, it will match the request after the tenant name - if request is "/ext-ui/tenant/testOrg/custom/test", the pattern will match against /custom/test
    urlMatcherScope String
    Allowed values are EXT_API, EXT_UI_PROVIDER, EXT_UI_TENANT corresponding to /ext-api, /ext-ui/provider, /ext-ui/tenant/
    apiFilterId String
    externalEndpointId string
    ID of the External Endpoint where this API Filter will process the requests to
    urlMatcherPattern string
    Request URL pattern, written as a regular expression. This argument cannot exceed 1024 characters. In most cases, it should end with .* (it is like a suffix) which specifies that all the parts of the URL coming after (like parameters) will be redirected to an external endpoint. It is important to note that in the case of url_matcher_scope=EXT_UI_TENANT, the tenant name is not part of the pattern, it will match the request after the tenant name - if request is "/ext-ui/tenant/testOrg/custom/test", the pattern will match against /custom/test
    urlMatcherScope string
    Allowed values are EXT_API, EXT_UI_PROVIDER, EXT_UI_TENANT corresponding to /ext-api, /ext-ui/provider, /ext-ui/tenant/
    apiFilterId string
    external_endpoint_id str
    ID of the External Endpoint where this API Filter will process the requests to
    url_matcher_pattern str
    Request URL pattern, written as a regular expression. This argument cannot exceed 1024 characters. In most cases, it should end with .* (it is like a suffix) which specifies that all the parts of the URL coming after (like parameters) will be redirected to an external endpoint. It is important to note that in the case of url_matcher_scope=EXT_UI_TENANT, the tenant name is not part of the pattern, it will match the request after the tenant name - if request is "/ext-ui/tenant/testOrg/custom/test", the pattern will match against /custom/test
    url_matcher_scope str
    Allowed values are EXT_API, EXT_UI_PROVIDER, EXT_UI_TENANT corresponding to /ext-api, /ext-ui/provider, /ext-ui/tenant/
    api_filter_id str
    externalEndpointId String
    ID of the External Endpoint where this API Filter will process the requests to
    urlMatcherPattern String
    Request URL pattern, written as a regular expression. This argument cannot exceed 1024 characters. In most cases, it should end with .* (it is like a suffix) which specifies that all the parts of the URL coming after (like parameters) will be redirected to an external endpoint. It is important to note that in the case of url_matcher_scope=EXT_UI_TENANT, the tenant name is not part of the pattern, it will match the request after the tenant name - if request is "/ext-ui/tenant/testOrg/custom/test", the pattern will match against /custom/test
    urlMatcherScope String
    Allowed values are EXT_API, EXT_UI_PROVIDER, EXT_UI_TENANT corresponding to /ext-api, /ext-ui/provider, /ext-ui/tenant/
    apiFilterId String

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ApiFilter 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 ApiFilter Resource

    Get an existing ApiFilter 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?: ApiFilterState, opts?: CustomResourceOptions): ApiFilter
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_filter_id: Optional[str] = None,
        external_endpoint_id: Optional[str] = None,
        url_matcher_pattern: Optional[str] = None,
        url_matcher_scope: Optional[str] = None) -> ApiFilter
    func GetApiFilter(ctx *Context, name string, id IDInput, state *ApiFilterState, opts ...ResourceOption) (*ApiFilter, error)
    public static ApiFilter Get(string name, Input<string> id, ApiFilterState? state, CustomResourceOptions? opts = null)
    public static ApiFilter get(String name, Output<String> id, ApiFilterState state, CustomResourceOptions options)
    resources:  _:    type: vcd:ApiFilter    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:
    ApiFilterId string
    ExternalEndpointId string
    ID of the External Endpoint where this API Filter will process the requests to
    UrlMatcherPattern string
    Request URL pattern, written as a regular expression. This argument cannot exceed 1024 characters. In most cases, it should end with .* (it is like a suffix) which specifies that all the parts of the URL coming after (like parameters) will be redirected to an external endpoint. It is important to note that in the case of url_matcher_scope=EXT_UI_TENANT, the tenant name is not part of the pattern, it will match the request after the tenant name - if request is "/ext-ui/tenant/testOrg/custom/test", the pattern will match against /custom/test
    UrlMatcherScope string
    Allowed values are EXT_API, EXT_UI_PROVIDER, EXT_UI_TENANT corresponding to /ext-api, /ext-ui/provider, /ext-ui/tenant/
    ApiFilterId string
    ExternalEndpointId string
    ID of the External Endpoint where this API Filter will process the requests to
    UrlMatcherPattern string
    Request URL pattern, written as a regular expression. This argument cannot exceed 1024 characters. In most cases, it should end with .* (it is like a suffix) which specifies that all the parts of the URL coming after (like parameters) will be redirected to an external endpoint. It is important to note that in the case of url_matcher_scope=EXT_UI_TENANT, the tenant name is not part of the pattern, it will match the request after the tenant name - if request is "/ext-ui/tenant/testOrg/custom/test", the pattern will match against /custom/test
    UrlMatcherScope string
    Allowed values are EXT_API, EXT_UI_PROVIDER, EXT_UI_TENANT corresponding to /ext-api, /ext-ui/provider, /ext-ui/tenant/
    apiFilterId String
    externalEndpointId String
    ID of the External Endpoint where this API Filter will process the requests to
    urlMatcherPattern String
    Request URL pattern, written as a regular expression. This argument cannot exceed 1024 characters. In most cases, it should end with .* (it is like a suffix) which specifies that all the parts of the URL coming after (like parameters) will be redirected to an external endpoint. It is important to note that in the case of url_matcher_scope=EXT_UI_TENANT, the tenant name is not part of the pattern, it will match the request after the tenant name - if request is "/ext-ui/tenant/testOrg/custom/test", the pattern will match against /custom/test
    urlMatcherScope String
    Allowed values are EXT_API, EXT_UI_PROVIDER, EXT_UI_TENANT corresponding to /ext-api, /ext-ui/provider, /ext-ui/tenant/
    apiFilterId string
    externalEndpointId string
    ID of the External Endpoint where this API Filter will process the requests to
    urlMatcherPattern string
    Request URL pattern, written as a regular expression. This argument cannot exceed 1024 characters. In most cases, it should end with .* (it is like a suffix) which specifies that all the parts of the URL coming after (like parameters) will be redirected to an external endpoint. It is important to note that in the case of url_matcher_scope=EXT_UI_TENANT, the tenant name is not part of the pattern, it will match the request after the tenant name - if request is "/ext-ui/tenant/testOrg/custom/test", the pattern will match against /custom/test
    urlMatcherScope string
    Allowed values are EXT_API, EXT_UI_PROVIDER, EXT_UI_TENANT corresponding to /ext-api, /ext-ui/provider, /ext-ui/tenant/
    api_filter_id str
    external_endpoint_id str
    ID of the External Endpoint where this API Filter will process the requests to
    url_matcher_pattern str
    Request URL pattern, written as a regular expression. This argument cannot exceed 1024 characters. In most cases, it should end with .* (it is like a suffix) which specifies that all the parts of the URL coming after (like parameters) will be redirected to an external endpoint. It is important to note that in the case of url_matcher_scope=EXT_UI_TENANT, the tenant name is not part of the pattern, it will match the request after the tenant name - if request is "/ext-ui/tenant/testOrg/custom/test", the pattern will match against /custom/test
    url_matcher_scope str
    Allowed values are EXT_API, EXT_UI_PROVIDER, EXT_UI_TENANT corresponding to /ext-api, /ext-ui/provider, /ext-ui/tenant/
    apiFilterId String
    externalEndpointId String
    ID of the External Endpoint where this API Filter will process the requests to
    urlMatcherPattern String
    Request URL pattern, written as a regular expression. This argument cannot exceed 1024 characters. In most cases, it should end with .* (it is like a suffix) which specifies that all the parts of the URL coming after (like parameters) will be redirected to an external endpoint. It is important to note that in the case of url_matcher_scope=EXT_UI_TENANT, the tenant name is not part of the pattern, it will match the request after the tenant name - if request is "/ext-ui/tenant/testOrg/custom/test", the pattern will match against /custom/test
    urlMatcherScope String
    Allowed values are EXT_API, EXT_UI_PROVIDER, EXT_UI_TENANT corresponding to /ext-api, /ext-ui/provider, /ext-ui/tenant/

    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
    vmware/terraform-provider-vcd