Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Nsxt Provider
  4. API Docs
  5. PolicyIdpsClusterConfig
Viewing docs for nsxt 3.12.0
published on Monday, May 18, 2026 by vmware
Schema (JSON)
vmware/terraform-provider-nsxt

nsxt.PolicyIdpsClusterConfig

Viewing docs for nsxt 3.12.0
published on Monday, May 18, 2026 by vmware
Schema (JSON)
vmware/terraform-provider-nsxt

    Create PolicyIdpsClusterConfig Resource

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

    Constructor syntax

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

@overload
def PolicyIdpsClusterConfig(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            cluster: Optional[PolicyIdpsClusterConfigClusterArgs] = None,
                            display_name: Optional[str] = None,
                            ids_enabled: Optional[bool] = None,
                            context: Optional[PolicyIdpsClusterConfigContextArgs] = None,
                            description: Optional[str] = None,
                            nsx_id: Optional[str] = None,
                            policy_idps_cluster_config_id: Optional[str] = None,
                            tags: Optional[Sequence[PolicyIdpsClusterConfigTagArgs]] = None)
    func NewPolicyIdpsClusterConfig(ctx *Context, name string, args PolicyIdpsClusterConfigArgs, opts ...ResourceOption) (*PolicyIdpsClusterConfig, error)
    public PolicyIdpsClusterConfig(string name, PolicyIdpsClusterConfigArgs args, CustomResourceOptions? opts = null)
    public PolicyIdpsClusterConfig(String name, PolicyIdpsClusterConfigArgs args)
public PolicyIdpsClusterConfig(String name, PolicyIdpsClusterConfigArgs args, CustomResourceOptions options)

    type: nsxt:PolicyIdpsClusterConfig
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "nsxt_policyidpsclusterconfig" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args PolicyIdpsClusterConfigArgs
    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 PolicyIdpsClusterConfigArgs
    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 PolicyIdpsClusterConfigArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicyIdpsClusterConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicyIdpsClusterConfigArgs
    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 policyIdpsClusterConfigResource = new Nsxt.PolicyIdpsClusterConfig("policyIdpsClusterConfigResource", new()
{
    Cluster = new Nsxt.Inputs.PolicyIdpsClusterConfigClusterArgs
    {
        TargetId = "string",
        TargetType = "string",
    },
    DisplayName = "string",
    IdsEnabled = false,
    Context = new Nsxt.Inputs.PolicyIdpsClusterConfigContextArgs
    {
        ProjectId = "string",
    },
    Description = "string",
    NsxId = "string",
    PolicyIdpsClusterConfigId = "string",
    Tags = new[]
    {
        new Nsxt.Inputs.PolicyIdpsClusterConfigTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
});

    example, err := nsxt.NewPolicyIdpsClusterConfig(ctx, "policyIdpsClusterConfigResource", &nsxt.PolicyIdpsClusterConfigArgs{
	Cluster: &nsxt.PolicyIdpsClusterConfigClusterArgs{
		TargetId:   pulumi.String("string"),
		TargetType: pulumi.String("string"),
	},
	DisplayName: pulumi.String("string"),
	IdsEnabled:  pulumi.Bool(false),
	Context: &nsxt.PolicyIdpsClusterConfigContextArgs{
		ProjectId: pulumi.String("string"),
	},
	Description:               pulumi.String("string"),
	NsxId:                     pulumi.String("string"),
	PolicyIdpsClusterConfigId: pulumi.String("string"),
	Tags: nsxt.PolicyIdpsClusterConfigTagArray{
		&nsxt.PolicyIdpsClusterConfigTagArgs{
			Scope: pulumi.String("string"),
			Tag:   pulumi.String("string"),
		},
	},
})

    resource "nsxt_policyidpsclusterconfig" "policyIdpsClusterConfigResource" {
  cluster = {
    target_id   = "string"
    target_type = "string"
  }
  display_name = "string"
  ids_enabled  = false
  context = {
    project_id = "string"
  }
  description                   = "string"
  nsx_id                        = "string"
  policy_idps_cluster_config_id = "string"
  tags {
    scope = "string"
    tag   = "string"
  }
}

    var policyIdpsClusterConfigResource = new PolicyIdpsClusterConfig("policyIdpsClusterConfigResource", PolicyIdpsClusterConfigArgs.builder()
    .cluster(PolicyIdpsClusterConfigClusterArgs.builder()
        .targetId("string")
        .targetType("string")
        .build())
    .displayName("string")
    .idsEnabled(false)
    .context(PolicyIdpsClusterConfigContextArgs.builder()
        .projectId("string")
        .build())
    .description("string")
    .nsxId("string")
    .policyIdpsClusterConfigId("string")
    .tags(PolicyIdpsClusterConfigTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .build());

    policy_idps_cluster_config_resource = nsxt.PolicyIdpsClusterConfig("policyIdpsClusterConfigResource",
    cluster={
        "target_id": "string",
        "target_type": "string",
    },
    display_name="string",
    ids_enabled=False,
    context={
        "project_id": "string",
    },
    description="string",
    nsx_id="string",
    policy_idps_cluster_config_id="string",
    tags=[{
        "scope": "string",
        "tag": "string",
    }])

    const policyIdpsClusterConfigResource = new nsxt.PolicyIdpsClusterConfig("policyIdpsClusterConfigResource", {
    cluster: {
        targetId: "string",
        targetType: "string",
    },
    displayName: "string",
    idsEnabled: false,
    context: {
        projectId: "string",
    },
    description: "string",
    nsxId: "string",
    policyIdpsClusterConfigId: "string",
    tags: [{
        scope: "string",
        tag: "string",
    }],
});

    type: nsxt:PolicyIdpsClusterConfig
properties:
    cluster:
        targetId: string
        targetType: string
    context:
        projectId: string
    description: string
    displayName: string
    idsEnabled: false
    nsxId: string
    policyIdpsClusterConfigId: string
    tags:
        - scope: string
          tag: string

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

    Cluster PolicyIdpsClusterConfigCluster
    Cluster reference configuration. Exactly one cluster block is required.
    DisplayName string
    Display name of the resource.
    IdsEnabled bool
    Enable or disable IDS for the cluster (TF-IDPS-001).
    Context PolicyIdpsClusterConfigContext
    Resource context
    Description string
    Description of the resource.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    PolicyIdpsClusterConfigId string
    ID of the IDPS cluster configuration. This will be the same as the cluster target_id.
    Tags List<PolicyIdpsClusterConfigTag>
    A list of scope + tag pairs to associate with this resource.
    Cluster PolicyIdpsClusterConfigClusterArgs
    Cluster reference configuration. Exactly one cluster block is required.
    DisplayName string
    Display name of the resource.
    IdsEnabled bool
    Enable or disable IDS for the cluster (TF-IDPS-001).
    Context PolicyIdpsClusterConfigContextArgs
    Resource context
    Description string
    Description of the resource.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    PolicyIdpsClusterConfigId string
    ID of the IDPS cluster configuration. This will be the same as the cluster target_id.
    Tags []PolicyIdpsClusterConfigTagArgs
    A list of scope + tag pairs to associate with this resource.
    cluster object
    Cluster reference configuration. Exactly one cluster block is required.
    display_name string
    Display name of the resource.
    ids_enabled bool
    Enable or disable IDS for the cluster (TF-IDPS-001).
    context object
    Resource context
    description string
    Description of the resource.
    nsx_id string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policy_idps_cluster_config_id string
    ID of the IDPS cluster configuration. This will be the same as the cluster target_id.
    tags list(object)
    A list of scope + tag pairs to associate with this resource.
    cluster PolicyIdpsClusterConfigCluster
    Cluster reference configuration. Exactly one cluster block is required.
    displayName String
    Display name of the resource.
    idsEnabled Boolean
    Enable or disable IDS for the cluster (TF-IDPS-001).
    context PolicyIdpsClusterConfigContext
    Resource context
    description String
    Description of the resource.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policyIdpsClusterConfigId String
    ID of the IDPS cluster configuration. This will be the same as the cluster target_id.
    tags List<PolicyIdpsClusterConfigTag>
    A list of scope + tag pairs to associate with this resource.
    cluster PolicyIdpsClusterConfigCluster
    Cluster reference configuration. Exactly one cluster block is required.
    displayName string
    Display name of the resource.
    idsEnabled boolean
    Enable or disable IDS for the cluster (TF-IDPS-001).
    context PolicyIdpsClusterConfigContext
    Resource context
    description string
    Description of the resource.
    nsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policyIdpsClusterConfigId string
    ID of the IDPS cluster configuration. This will be the same as the cluster target_id.
    tags PolicyIdpsClusterConfigTag[]
    A list of scope + tag pairs to associate with this resource.
    cluster PolicyIdpsClusterConfigClusterArgs
    Cluster reference configuration. Exactly one cluster block is required.
    display_name str
    Display name of the resource.
    ids_enabled bool
    Enable or disable IDS for the cluster (TF-IDPS-001).
    context PolicyIdpsClusterConfigContextArgs
    Resource context
    description str
    Description of the resource.
    nsx_id str
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policy_idps_cluster_config_id str
    ID of the IDPS cluster configuration. This will be the same as the cluster target_id.
    tags Sequence[PolicyIdpsClusterConfigTagArgs]
    A list of scope + tag pairs to associate with this resource.
    cluster Property Map
    Cluster reference configuration. Exactly one cluster block is required.
    displayName String
    Display name of the resource.
    idsEnabled Boolean
    Enable or disable IDS for the cluster (TF-IDPS-001).
    context Property Map
    Resource context
    description String
    Description of the resource.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policyIdpsClusterConfigId String
    ID of the IDPS cluster configuration. This will be the same as the cluster target_id.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this resource.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Path string
    The NSX policy path of the resource.
    Revision double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    Id string
    The provider-assigned unique ID for this managed resource.
    Path string
    The NSX policy path of the resource.
    Revision float64
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    id string
    The provider-assigned unique ID for this managed resource.
    path string
    The NSX policy path of the resource.
    revision number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    id String
    The provider-assigned unique ID for this managed resource.
    path String
    The NSX policy path of the resource.
    revision Double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    id string
    The provider-assigned unique ID for this managed resource.
    path string
    The NSX policy path of the resource.
    revision number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    id str
    The provider-assigned unique ID for this managed resource.
    path str
    The NSX policy path of the resource.
    revision float
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    id String
    The provider-assigned unique ID for this managed resource.
    path String
    The NSX policy path of the resource.
    revision Number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.

    Look up Existing PolicyIdpsClusterConfig Resource

    Get an existing PolicyIdpsClusterConfig 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?: PolicyIdpsClusterConfigState, opts?: CustomResourceOptions): PolicyIdpsClusterConfig
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cluster: Optional[PolicyIdpsClusterConfigClusterArgs] = None,
        context: Optional[PolicyIdpsClusterConfigContextArgs] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        ids_enabled: Optional[bool] = None,
        nsx_id: Optional[str] = None,
        path: Optional[str] = None,
        policy_idps_cluster_config_id: Optional[str] = None,
        revision: Optional[float] = None,
        tags: Optional[Sequence[PolicyIdpsClusterConfigTagArgs]] = None) -> PolicyIdpsClusterConfig
    func GetPolicyIdpsClusterConfig(ctx *Context, name string, id IDInput, state *PolicyIdpsClusterConfigState, opts ...ResourceOption) (*PolicyIdpsClusterConfig, error)
    public static PolicyIdpsClusterConfig Get(string name, Input<string> id, PolicyIdpsClusterConfigState? state, CustomResourceOptions? opts = null)
    public static PolicyIdpsClusterConfig get(String name, Output<String> id, PolicyIdpsClusterConfigState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:PolicyIdpsClusterConfig    get:      id: ${id}
    import {
  to = nsxt_policyidpsclusterconfig.example
  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:
    Cluster PolicyIdpsClusterConfigCluster
    Cluster reference configuration. Exactly one cluster block is required.
    Context PolicyIdpsClusterConfigContext
    Resource context
    Description string
    Description of the resource.
    DisplayName string
    Display name of the resource.
    IdsEnabled bool
    Enable or disable IDS for the cluster (TF-IDPS-001).
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    Path string
    The NSX policy path of the resource.
    PolicyIdpsClusterConfigId string
    ID of the IDPS cluster configuration. This will be the same as the cluster target_id.
    Revision double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    Tags List<PolicyIdpsClusterConfigTag>
    A list of scope + tag pairs to associate with this resource.
    Cluster PolicyIdpsClusterConfigClusterArgs
    Cluster reference configuration. Exactly one cluster block is required.
    Context PolicyIdpsClusterConfigContextArgs
    Resource context
    Description string
    Description of the resource.
    DisplayName string
    Display name of the resource.
    IdsEnabled bool
    Enable or disable IDS for the cluster (TF-IDPS-001).
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    Path string
    The NSX policy path of the resource.
    PolicyIdpsClusterConfigId string
    ID of the IDPS cluster configuration. This will be the same as the cluster target_id.
    Revision float64
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    Tags []PolicyIdpsClusterConfigTagArgs
    A list of scope + tag pairs to associate with this resource.
    cluster object
    Cluster reference configuration. Exactly one cluster block is required.
    context object
    Resource context
    description string
    Description of the resource.
    display_name string
    Display name of the resource.
    ids_enabled bool
    Enable or disable IDS for the cluster (TF-IDPS-001).
    nsx_id string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    path string
    The NSX policy path of the resource.
    policy_idps_cluster_config_id string
    ID of the IDPS cluster configuration. This will be the same as the cluster target_id.
    revision number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags list(object)
    A list of scope + tag pairs to associate with this resource.
    cluster PolicyIdpsClusterConfigCluster
    Cluster reference configuration. Exactly one cluster block is required.
    context PolicyIdpsClusterConfigContext
    Resource context
    description String
    Description of the resource.
    displayName String
    Display name of the resource.
    idsEnabled Boolean
    Enable or disable IDS for the cluster (TF-IDPS-001).
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    path String
    The NSX policy path of the resource.
    policyIdpsClusterConfigId String
    ID of the IDPS cluster configuration. This will be the same as the cluster target_id.
    revision Double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags List<PolicyIdpsClusterConfigTag>
    A list of scope + tag pairs to associate with this resource.
    cluster PolicyIdpsClusterConfigCluster
    Cluster reference configuration. Exactly one cluster block is required.
    context PolicyIdpsClusterConfigContext
    Resource context
    description string
    Description of the resource.
    displayName string
    Display name of the resource.
    idsEnabled boolean
    Enable or disable IDS for the cluster (TF-IDPS-001).
    nsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    path string
    The NSX policy path of the resource.
    policyIdpsClusterConfigId string
    ID of the IDPS cluster configuration. This will be the same as the cluster target_id.
    revision number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags PolicyIdpsClusterConfigTag[]
    A list of scope + tag pairs to associate with this resource.
    cluster PolicyIdpsClusterConfigClusterArgs
    Cluster reference configuration. Exactly one cluster block is required.
    context PolicyIdpsClusterConfigContextArgs
    Resource context
    description str
    Description of the resource.
    display_name str
    Display name of the resource.
    ids_enabled bool
    Enable or disable IDS for the cluster (TF-IDPS-001).
    nsx_id str
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    path str
    The NSX policy path of the resource.
    policy_idps_cluster_config_id str
    ID of the IDPS cluster configuration. This will be the same as the cluster target_id.
    revision float
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags Sequence[PolicyIdpsClusterConfigTagArgs]
    A list of scope + tag pairs to associate with this resource.
    cluster Property Map
    Cluster reference configuration. Exactly one cluster block is required.
    context Property Map
    Resource context
    description String
    Description of the resource.
    displayName String
    Display name of the resource.
    idsEnabled Boolean
    Enable or disable IDS for the cluster (TF-IDPS-001).
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    path String
    The NSX policy path of the resource.
    policyIdpsClusterConfigId String
    ID of the IDPS cluster configuration. This will be the same as the cluster target_id.
    revision Number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this resource.

    Supporting Types

    PolicyIdpsClusterConfigCluster, PolicyIdpsClusterConfigClusterArgs

    TargetId string
    Cluster target ID (e.g., domain-c123). This cannot be changed after creation.
    TargetType string
    Target type (e.g., VC_Cluster). This cannot be changed after creation.
    TargetId string
    Cluster target ID (e.g., domain-c123). This cannot be changed after creation.
    TargetType string
    Target type (e.g., VC_Cluster). This cannot be changed after creation.
    target_id string
    Cluster target ID (e.g., domain-c123). This cannot be changed after creation.
    target_type string
    Target type (e.g., VC_Cluster). This cannot be changed after creation.
    targetId String
    Cluster target ID (e.g., domain-c123). This cannot be changed after creation.
    targetType String
    Target type (e.g., VC_Cluster). This cannot be changed after creation.
    targetId string
    Cluster target ID (e.g., domain-c123). This cannot be changed after creation.
    targetType string
    Target type (e.g., VC_Cluster). This cannot be changed after creation.
    target_id str
    Cluster target ID (e.g., domain-c123). This cannot be changed after creation.
    target_type str
    Target type (e.g., VC_Cluster). This cannot be changed after creation.
    targetId String
    Cluster target ID (e.g., domain-c123). This cannot be changed after creation.
    targetType String
    Target type (e.g., VC_Cluster). This cannot be changed after creation.

    PolicyIdpsClusterConfigContext, PolicyIdpsClusterConfigContextArgs

    ProjectId string
    Id of the project which the resource belongs to.
    ProjectId string
    Id of the project which the resource belongs to.
    project_id string
    Id of the project which the resource belongs to.
    projectId String
    Id of the project which the resource belongs to.
    projectId string
    Id of the project which the resource belongs to.
    project_id str
    Id of the project which the resource belongs to.
    projectId String
    Id of the project which the resource belongs to.

    PolicyIdpsClusterConfigTag, PolicyIdpsClusterConfigTagArgs

    Scope string
    Tag string
    A list of scope + tag pairs to associate with this resource.
    Scope string
    Tag string
    A list of scope + tag pairs to associate with this resource.
    scope string
    tag string
    A list of scope + tag pairs to associate with this resource.
    scope String
    tag String
    A list of scope + tag pairs to associate with this resource.
    scope string
    tag string
    A list of scope + tag pairs to associate with this resource.
    scope str
    tag str
    A list of scope + tag pairs to associate with this resource.
    scope String
    tag String
    A list of scope + tag pairs to associate with this resource.

    Package Details

    Repository
    nsxt vmware/terraform-provider-nsxt
    License
    Notes
    This Pulumi package is based on the nsxt Terraform Provider.
    Viewing docs for nsxt 3.12.0
    published on Monday, May 18, 2026 by vmware
    Schema (JSON)
    vmware/terraform-provider-nsxt

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial