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

vcd.RightsBundle

Explore with Pulumi AI

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

    Create RightsBundle Resource

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

    Constructor syntax

    new RightsBundle(name: string, args: RightsBundleArgs, opts?: CustomResourceOptions);
    @overload
    def RightsBundle(resource_name: str,
                     args: RightsBundleArgs,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def RightsBundle(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     description: Optional[str] = None,
                     publish_to_all_tenants: Optional[bool] = None,
                     name: Optional[str] = None,
                     rights: Optional[Sequence[str]] = None,
                     rights_bundle_id: Optional[str] = None,
                     tenants: Optional[Sequence[str]] = None)
    func NewRightsBundle(ctx *Context, name string, args RightsBundleArgs, opts ...ResourceOption) (*RightsBundle, error)
    public RightsBundle(string name, RightsBundleArgs args, CustomResourceOptions? opts = null)
    public RightsBundle(String name, RightsBundleArgs args)
    public RightsBundle(String name, RightsBundleArgs args, CustomResourceOptions options)
    
    type: vcd:RightsBundle
    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 RightsBundleArgs
    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 RightsBundleArgs
    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 RightsBundleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RightsBundleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RightsBundleArgs
    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 rightsBundleResource = new Vcd.RightsBundle("rightsBundleResource", new()
    {
        Description = "string",
        PublishToAllTenants = false,
        Name = "string",
        Rights = new[]
        {
            "string",
        },
        RightsBundleId = "string",
        Tenants = new[]
        {
            "string",
        },
    });
    
    example, err := vcd.NewRightsBundle(ctx, "rightsBundleResource", &vcd.RightsBundleArgs{
    	Description:         pulumi.String("string"),
    	PublishToAllTenants: pulumi.Bool(false),
    	Name:                pulumi.String("string"),
    	Rights: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	RightsBundleId: pulumi.String("string"),
    	Tenants: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    var rightsBundleResource = new RightsBundle("rightsBundleResource", RightsBundleArgs.builder()
        .description("string")
        .publishToAllTenants(false)
        .name("string")
        .rights("string")
        .rightsBundleId("string")
        .tenants("string")
        .build());
    
    rights_bundle_resource = vcd.RightsBundle("rightsBundleResource",
        description="string",
        publish_to_all_tenants=False,
        name="string",
        rights=["string"],
        rights_bundle_id="string",
        tenants=["string"])
    
    const rightsBundleResource = new vcd.RightsBundle("rightsBundleResource", {
        description: "string",
        publishToAllTenants: false,
        name: "string",
        rights: ["string"],
        rightsBundleId: "string",
        tenants: ["string"],
    });
    
    type: vcd:RightsBundle
    properties:
        description: string
        name: string
        publishToAllTenants: false
        rights:
            - string
        rightsBundleId: string
        tenants:
            - string
    

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

    Description string
    A description of the rights bundle
    PublishToAllTenants bool
    When true, publishes the rights bundle to all tenants
    Name string
    The name of the rights bundle.
    Rights List<string>
    Set of rights assigned to this role
    RightsBundleId string
    Tenants List<string>
    Set of tenants to which this rights bundle gets published. Ignored if publish_to_all_tenants is true.
    Description string
    A description of the rights bundle
    PublishToAllTenants bool
    When true, publishes the rights bundle to all tenants
    Name string
    The name of the rights bundle.
    Rights []string
    Set of rights assigned to this role
    RightsBundleId string
    Tenants []string
    Set of tenants to which this rights bundle gets published. Ignored if publish_to_all_tenants is true.
    description String
    A description of the rights bundle
    publishToAllTenants Boolean
    When true, publishes the rights bundle to all tenants
    name String
    The name of the rights bundle.
    rights List<String>
    Set of rights assigned to this role
    rightsBundleId String
    tenants List<String>
    Set of tenants to which this rights bundle gets published. Ignored if publish_to_all_tenants is true.
    description string
    A description of the rights bundle
    publishToAllTenants boolean
    When true, publishes the rights bundle to all tenants
    name string
    The name of the rights bundle.
    rights string[]
    Set of rights assigned to this role
    rightsBundleId string
    tenants string[]
    Set of tenants to which this rights bundle gets published. Ignored if publish_to_all_tenants is true.
    description str
    A description of the rights bundle
    publish_to_all_tenants bool
    When true, publishes the rights bundle to all tenants
    name str
    The name of the rights bundle.
    rights Sequence[str]
    Set of rights assigned to this role
    rights_bundle_id str
    tenants Sequence[str]
    Set of tenants to which this rights bundle gets published. Ignored if publish_to_all_tenants is true.
    description String
    A description of the rights bundle
    publishToAllTenants Boolean
    When true, publishes the rights bundle to all tenants
    name String
    The name of the rights bundle.
    rights List<String>
    Set of rights assigned to this role
    rightsBundleId String
    tenants List<String>
    Set of tenants to which this rights bundle gets published. Ignored if publish_to_all_tenants is true.

    Outputs

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

    BundleKey string
    Key used for internationalization
    Id string
    The provider-assigned unique ID for this managed resource.
    ReadOnly bool
    Whether this rights bundle is read-only
    BundleKey string
    Key used for internationalization
    Id string
    The provider-assigned unique ID for this managed resource.
    ReadOnly bool
    Whether this rights bundle is read-only
    bundleKey String
    Key used for internationalization
    id String
    The provider-assigned unique ID for this managed resource.
    readOnly Boolean
    Whether this rights bundle is read-only
    bundleKey string
    Key used for internationalization
    id string
    The provider-assigned unique ID for this managed resource.
    readOnly boolean
    Whether this rights bundle is read-only
    bundle_key str
    Key used for internationalization
    id str
    The provider-assigned unique ID for this managed resource.
    read_only bool
    Whether this rights bundle is read-only
    bundleKey String
    Key used for internationalization
    id String
    The provider-assigned unique ID for this managed resource.
    readOnly Boolean
    Whether this rights bundle is read-only

    Look up Existing RightsBundle Resource

    Get an existing RightsBundle 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?: RightsBundleState, opts?: CustomResourceOptions): RightsBundle
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            bundle_key: Optional[str] = None,
            description: Optional[str] = None,
            name: Optional[str] = None,
            publish_to_all_tenants: Optional[bool] = None,
            read_only: Optional[bool] = None,
            rights: Optional[Sequence[str]] = None,
            rights_bundle_id: Optional[str] = None,
            tenants: Optional[Sequence[str]] = None) -> RightsBundle
    func GetRightsBundle(ctx *Context, name string, id IDInput, state *RightsBundleState, opts ...ResourceOption) (*RightsBundle, error)
    public static RightsBundle Get(string name, Input<string> id, RightsBundleState? state, CustomResourceOptions? opts = null)
    public static RightsBundle get(String name, Output<String> id, RightsBundleState state, CustomResourceOptions options)
    resources:  _:    type: vcd:RightsBundle    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:
    BundleKey string
    Key used for internationalization
    Description string
    A description of the rights bundle
    Name string
    The name of the rights bundle.
    PublishToAllTenants bool
    When true, publishes the rights bundle to all tenants
    ReadOnly bool
    Whether this rights bundle is read-only
    Rights List<string>
    Set of rights assigned to this role
    RightsBundleId string
    Tenants List<string>
    Set of tenants to which this rights bundle gets published. Ignored if publish_to_all_tenants is true.
    BundleKey string
    Key used for internationalization
    Description string
    A description of the rights bundle
    Name string
    The name of the rights bundle.
    PublishToAllTenants bool
    When true, publishes the rights bundle to all tenants
    ReadOnly bool
    Whether this rights bundle is read-only
    Rights []string
    Set of rights assigned to this role
    RightsBundleId string
    Tenants []string
    Set of tenants to which this rights bundle gets published. Ignored if publish_to_all_tenants is true.
    bundleKey String
    Key used for internationalization
    description String
    A description of the rights bundle
    name String
    The name of the rights bundle.
    publishToAllTenants Boolean
    When true, publishes the rights bundle to all tenants
    readOnly Boolean
    Whether this rights bundle is read-only
    rights List<String>
    Set of rights assigned to this role
    rightsBundleId String
    tenants List<String>
    Set of tenants to which this rights bundle gets published. Ignored if publish_to_all_tenants is true.
    bundleKey string
    Key used for internationalization
    description string
    A description of the rights bundle
    name string
    The name of the rights bundle.
    publishToAllTenants boolean
    When true, publishes the rights bundle to all tenants
    readOnly boolean
    Whether this rights bundle is read-only
    rights string[]
    Set of rights assigned to this role
    rightsBundleId string
    tenants string[]
    Set of tenants to which this rights bundle gets published. Ignored if publish_to_all_tenants is true.
    bundle_key str
    Key used for internationalization
    description str
    A description of the rights bundle
    name str
    The name of the rights bundle.
    publish_to_all_tenants bool
    When true, publishes the rights bundle to all tenants
    read_only bool
    Whether this rights bundle is read-only
    rights Sequence[str]
    Set of rights assigned to this role
    rights_bundle_id str
    tenants Sequence[str]
    Set of tenants to which this rights bundle gets published. Ignored if publish_to_all_tenants is true.
    bundleKey String
    Key used for internationalization
    description String
    A description of the rights bundle
    name String
    The name of the rights bundle.
    publishToAllTenants Boolean
    When true, publishes the rights bundle to all tenants
    readOnly Boolean
    Whether this rights bundle is read-only
    rights List<String>
    Set of rights assigned to this role
    rightsBundleId String
    tenants List<String>
    Set of tenants to which this rights bundle gets published. Ignored if publish_to_all_tenants is true.

    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