nsxt 3.8.0, Apr 14 25

nsxt 3.8.0 published on Monday, Apr 14, 2025 by vmware

nsxt.PolicySharedResource

Explore with Pulumi AI

nsxt 3.8.0 published on Monday, Apr 14, 2025 by vmware

Create PolicySharedResource Resource

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

Constructor syntax

new PolicySharedResource(name: string, args: PolicySharedResourceArgs, opts?: CustomResourceOptions);

@overload
def PolicySharedResource(resource_name: str,
                         args: PolicySharedResourceArgs,
                         opts: Optional[ResourceOptions] = None)

@overload
def PolicySharedResource(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         display_name: Optional[str] = None,
                         resource_objects: Optional[Sequence[PolicySharedResourceResourceObjectArgs]] = None,
                         share_path: Optional[str] = None,
                         description: Optional[str] = None,
                         nsx_id: Optional[str] = None,
                         policy_shared_resource_id: Optional[str] = None,
                         tags: Optional[Sequence[PolicySharedResourceTagArgs]] = None)

func NewPolicySharedResource(ctx *Context, name string, args PolicySharedResourceArgs, opts ...ResourceOption) (*PolicySharedResource, error)

public PolicySharedResource(string name, PolicySharedResourceArgs args, CustomResourceOptions? opts = null)

public PolicySharedResource(String name, PolicySharedResourceArgs args)
public PolicySharedResource(String name, PolicySharedResourceArgs args, CustomResourceOptions options)

type: nsxt:PolicySharedResource
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 PolicySharedResourceArgs: 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 PolicySharedResourceArgs: 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 PolicySharedResourceArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args PolicySharedResourceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args PolicySharedResourceArgs: 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 policySharedResourceResource = new Nsxt.PolicySharedResource("policySharedResourceResource", new()
{
    DisplayName = "string",
    ResourceObjects = new[]
    {
        new Nsxt.Inputs.PolicySharedResourceResourceObjectArgs
        {
            ResourcePath = "string",
            IncludeChildren = false,
        },
    },
    SharePath = "string",
    Description = "string",
    NsxId = "string",
    PolicySharedResourceId = "string",
    Tags = new[]
    {
        new Nsxt.Inputs.PolicySharedResourceTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
});

example, err := nsxt.NewPolicySharedResource(ctx, "policySharedResourceResource", &nsxt.PolicySharedResourceArgs{
	DisplayName: pulumi.String("string"),
	ResourceObjects: nsxt.PolicySharedResourceResourceObjectArray{
		&nsxt.PolicySharedResourceResourceObjectArgs{
			ResourcePath:    pulumi.String("string"),
			IncludeChildren: pulumi.Bool(false),
		},
	},
	SharePath:              pulumi.String("string"),
	Description:            pulumi.String("string"),
	NsxId:                  pulumi.String("string"),
	PolicySharedResourceId: pulumi.String("string"),
	Tags: nsxt.PolicySharedResourceTagArray{
		&nsxt.PolicySharedResourceTagArgs{
			Scope: pulumi.String("string"),
			Tag:   pulumi.String("string"),
		},
	},
})

var policySharedResourceResource = new PolicySharedResource("policySharedResourceResource", PolicySharedResourceArgs.builder()
    .displayName("string")
    .resourceObjects(PolicySharedResourceResourceObjectArgs.builder()
        .resourcePath("string")
        .includeChildren(false)
        .build())
    .sharePath("string")
    .description("string")
    .nsxId("string")
    .policySharedResourceId("string")
    .tags(PolicySharedResourceTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .build());

policy_shared_resource_resource = nsxt.PolicySharedResource("policySharedResourceResource",
    display_name="string",
    resource_objects=[{
        "resource_path": "string",
        "include_children": False,
    }],
    share_path="string",
    description="string",
    nsx_id="string",
    policy_shared_resource_id="string",
    tags=[{
        "scope": "string",
        "tag": "string",
    }])

const policySharedResourceResource = new nsxt.PolicySharedResource("policySharedResourceResource", {
    displayName: "string",
    resourceObjects: [{
        resourcePath: "string",
        includeChildren: false,
    }],
    sharePath: "string",
    description: "string",
    nsxId: "string",
    policySharedResourceId: "string",
    tags: [{
        scope: "string",
        tag: "string",
    }],
});

type: nsxt:PolicySharedResource
properties:
    description: string
    displayName: string
    nsxId: string
    policySharedResourceId: string
    resourceObjects:
        - includeChildren: false
          resourcePath: string
    sharePath: string
    tags:
        - scope: string
          tag: string

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

DisplayName string: Display name of the resource.
ResourceObjects List<PolicySharedResourceResourceObject>: _ (Required) List of resources to be shared.
SharePath string: Share policy path to associate the resource to.
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.
PolicySharedResourceId string: ID of the resource.
Tags List<PolicySharedResourceTag>: A list of scope + tag pairs to associate with this resource.

DisplayName string: Display name of the resource.
ResourceObjects []PolicySharedResourceResourceObjectArgs: _ (Required) List of resources to be shared.
SharePath string: Share policy path to associate the resource to.
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.
PolicySharedResourceId string: ID of the resource.
Tags []PolicySharedResourceTagArgs: A list of scope + tag pairs to associate with this resource.

displayName String: Display name of the resource.
resourceObjects List<PolicySharedResourceResourceObject>: _ (Required) List of resources to be shared.
sharePath String: Share policy path to associate the resource to.
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.
policySharedResourceId String: ID of the resource.
tags List<PolicySharedResourceTag>: A list of scope + tag pairs to associate with this resource.

displayName string: Display name of the resource.
resourceObjects PolicySharedResourceResourceObject[]: _ (Required) List of resources to be shared.
sharePath string: Share policy path to associate the resource to.
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.
policySharedResourceId string: ID of the resource.
tags PolicySharedResourceTag[]: A list of scope + tag pairs to associate with this resource.

display_name str: Display name of the resource.
resource_objects Sequence[PolicySharedResourceResourceObjectArgs]: _ (Required) List of resources to be shared.
share_path str: Share policy path to associate the resource to.
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_shared_resource_id str: ID of the resource.
tags Sequence[PolicySharedResourceTagArgs]: A list of scope + tag pairs to associate with this resource.

displayName String: Display name of the resource.
resourceObjects List<Property Map>: _ (Required) List of resources to be shared.
sharePath String: Share policy path to associate the resource to.
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.
policySharedResourceId String: ID of the resource.
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 PolicySharedResource resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.
Path string: The NSX path of the policy 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 path of the policy 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 path of the policy 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 path of the policy 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 path of the policy 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 path of the policy 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 PolicySharedResource Resource

Get an existing PolicySharedResource 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?: PolicySharedResourceState, opts?: CustomResourceOptions): PolicySharedResource

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        nsx_id: Optional[str] = None,
        path: Optional[str] = None,
        policy_shared_resource_id: Optional[str] = None,
        resource_objects: Optional[Sequence[PolicySharedResourceResourceObjectArgs]] = None,
        revision: Optional[float] = None,
        share_path: Optional[str] = None,
        tags: Optional[Sequence[PolicySharedResourceTagArgs]] = None) -> PolicySharedResource

func GetPolicySharedResource(ctx *Context, name string, id IDInput, state *PolicySharedResourceState, opts ...ResourceOption) (*PolicySharedResource, error)

public static PolicySharedResource Get(string name, Input<string> id, PolicySharedResourceState? state, CustomResourceOptions? opts = null)

public static PolicySharedResource get(String name, Output<String> id, PolicySharedResourceState state, CustomResourceOptions options)

resources:  _:    type: nsxt:PolicySharedResource    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:

Description string: Description of the resource.
DisplayName string: Display name of the resource.
NsxId 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.
PolicySharedResourceId string: ID of the resource.
ResourceObjects List<PolicySharedResourceResourceObject>: _ (Required) List of resources to be shared.
Revision double: Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
SharePath string: Share policy path to associate the resource to.
Tags List<PolicySharedResourceTag>: A list of scope + tag pairs to associate with this resource.

Description string: Description of the resource.
DisplayName string: Display name of the resource.
NsxId 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.
PolicySharedResourceId string: ID of the resource.
ResourceObjects []PolicySharedResourceResourceObjectArgs: _ (Required) List of resources to be shared.
Revision float64: Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
SharePath string: Share policy path to associate the resource to.
Tags []PolicySharedResourceTagArgs: A list of scope + tag pairs to associate with this resource.

description String: Description of the resource.
displayName String: Display name of the resource.
nsxId 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.
policySharedResourceId String: ID of the resource.
resourceObjects List<PolicySharedResourceResourceObject>: _ (Required) List of resources to be shared.
revision Double: Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
sharePath String: Share policy path to associate the resource to.
tags List<PolicySharedResourceTag>: A list of scope + tag pairs to associate with this resource.

description string: Description of the resource.
displayName string: Display name of the resource.
nsxId 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.
policySharedResourceId string: ID of the resource.
resourceObjects PolicySharedResourceResourceObject[]: _ (Required) List of resources to be shared.
revision number: Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
sharePath string: Share policy path to associate the resource to.
tags PolicySharedResourceTag[]: A list of scope + tag pairs to associate with this resource.

description str: Description of the resource.
display_name str: Display name of the resource.
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.
policy_shared_resource_id str: ID of the resource.
resource_objects Sequence[PolicySharedResourceResourceObjectArgs]: _ (Required) List of resources to be shared.
revision float: Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
share_path str: Share policy path to associate the resource to.
tags Sequence[PolicySharedResourceTagArgs]: A list of scope + tag pairs to associate with this resource.

description String: Description of the resource.
displayName String: Display name of the resource.
nsxId 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.
policySharedResourceId String: ID of the resource.
resourceObjects List<Property Map>: _ (Required) List of resources to be shared.
revision Number: Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
sharePath String: Share policy path to associate the resource to.
tags List<Property Map>: A list of scope + tag pairs to associate with this resource.

Supporting Types

PolicySharedResourceResourceObject, PolicySharedResourceResourceObjectArgs

ResourcePath string: Path of the resource to be shared.
IncludeChildren bool: Denotes if the children of the shared path are also shared.

ResourcePath string: Path of the resource to be shared.
IncludeChildren bool: Denotes if the children of the shared path are also shared.

resourcePath String: Path of the resource to be shared.
includeChildren Boolean: Denotes if the children of the shared path are also shared.

resourcePath string: Path of the resource to be shared.
includeChildren boolean: Denotes if the children of the shared path are also shared.

resource_path str: Path of the resource to be shared.
include_children bool: Denotes if the children of the shared path are also shared.

resourcePath String: Path of the resource to be shared.
includeChildren Boolean: Denotes if the children of the shared path are also shared.

PolicySharedResourceTag, PolicySharedResourceTagArgs

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.

nsxt 3.8.0 published on Monday, Apr 14, 2025 by vmware

vmware/terraform-provider-nsxt

nsxt.PolicySharedResource

On this page

On this page

Create PolicySharedResource Resource

Constructor syntax

Parameters

Constructor example

PolicySharedResource Resource Properties

Inputs

Outputs

Look up Existing PolicySharedResource Resource

Supporting Types

PolicySharedResourceResourceObject, PolicySharedResourceResourceObjectArgs

PolicySharedResourceTag, PolicySharedResourceTagArgs

Package Details

On this page

On this page