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

vcd.VappAccessControl

Explore with Pulumi AI

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

    Create VappAccessControl Resource

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

    Constructor syntax

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

@overload
def VappAccessControl(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      shared_with_everyone: Optional[bool] = None,
                      vapp_id: Optional[str] = None,
                      everyone_access_level: Optional[str] = None,
                      org: Optional[str] = None,
                      shared_withs: Optional[Sequence[VappAccessControlSharedWithArgs]] = None,
                      vapp_access_control_id: Optional[str] = None,
                      vdc: Optional[str] = None)
    func NewVappAccessControl(ctx *Context, name string, args VappAccessControlArgs, opts ...ResourceOption) (*VappAccessControl, error)
    public VappAccessControl(string name, VappAccessControlArgs args, CustomResourceOptions? opts = null)
    public VappAccessControl(String name, VappAccessControlArgs args)
public VappAccessControl(String name, VappAccessControlArgs args, CustomResourceOptions options)

    type: vcd:VappAccessControl
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 VappAccessControlArgs
    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 VappAccessControlArgs
    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 VappAccessControlArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VappAccessControlArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VappAccessControlArgs
    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 vappAccessControlResource = new Vcd.VappAccessControl("vappAccessControlResource", new()
{
    SharedWithEveryone = false,
    VappId = "string",
    EveryoneAccessLevel = "string",
    Org = "string",
    SharedWiths = new[]
    {
        new Vcd.Inputs.VappAccessControlSharedWithArgs
        {
            AccessLevel = "string",
            GroupId = "string",
            SubjectName = "string",
            UserId = "string",
        },
    },
    VappAccessControlId = "string",
    Vdc = "string",
});

    example, err := vcd.NewVappAccessControl(ctx, "vappAccessControlResource", &vcd.VappAccessControlArgs{
	SharedWithEveryone:  pulumi.Bool(false),
	VappId:              pulumi.String("string"),
	EveryoneAccessLevel: pulumi.String("string"),
	Org:                 pulumi.String("string"),
	SharedWiths: vcd.VappAccessControlSharedWithArray{
		&vcd.VappAccessControlSharedWithArgs{
			AccessLevel: pulumi.String("string"),
			GroupId:     pulumi.String("string"),
			SubjectName: pulumi.String("string"),
			UserId:      pulumi.String("string"),
		},
	},
	VappAccessControlId: pulumi.String("string"),
	Vdc:                 pulumi.String("string"),
})

    var vappAccessControlResource = new VappAccessControl("vappAccessControlResource", VappAccessControlArgs.builder()
    .sharedWithEveryone(false)
    .vappId("string")
    .everyoneAccessLevel("string")
    .org("string")
    .sharedWiths(VappAccessControlSharedWithArgs.builder()
        .accessLevel("string")
        .groupId("string")
        .subjectName("string")
        .userId("string")
        .build())
    .vappAccessControlId("string")
    .vdc("string")
    .build());

    vapp_access_control_resource = vcd.VappAccessControl("vappAccessControlResource",
    shared_with_everyone=False,
    vapp_id="string",
    everyone_access_level="string",
    org="string",
    shared_withs=[{
        "access_level": "string",
        "group_id": "string",
        "subject_name": "string",
        "user_id": "string",
    }],
    vapp_access_control_id="string",
    vdc="string")

    const vappAccessControlResource = new vcd.VappAccessControl("vappAccessControlResource", {
    sharedWithEveryone: false,
    vappId: "string",
    everyoneAccessLevel: "string",
    org: "string",
    sharedWiths: [{
        accessLevel: "string",
        groupId: "string",
        subjectName: "string",
        userId: "string",
    }],
    vappAccessControlId: "string",
    vdc: "string",
});

    type: vcd:VappAccessControl
properties:
    everyoneAccessLevel: string
    org: string
    sharedWithEveryone: false
    sharedWiths:
        - accessLevel: string
          groupId: string
          subjectName: string
          userId: string
    vappAccessControlId: string
    vappId: string
    vdc: string

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

    SharedWithEveryone bool
    Whether the vApp is shared with everyone. If any shared_with blocks are included, this property must be set to false.
    VappId string
    A unique identifier for the vApp.
    EveryoneAccessLevel string
    Access level when the vApp is shared with everyone (one of ReadOnly, Change, FullControl). Required if shared_with_everyone is true.
    Org string
    The name of organization to which the vApp belongs. Optional if defined at provider level.
    SharedWiths List<VappAccessControlSharedWith>
    one or more blocks defining a subject to which we are sharing. See shared_with below for detail. It cannot be used if shared_with_everyone is set.
    VappAccessControlId string
    Vdc string
    The name of organization to which the vApp belongs. Optional if defined at provider level.
    SharedWithEveryone bool
    Whether the vApp is shared with everyone. If any shared_with blocks are included, this property must be set to false.
    VappId string
    A unique identifier for the vApp.
    EveryoneAccessLevel string
    Access level when the vApp is shared with everyone (one of ReadOnly, Change, FullControl). Required if shared_with_everyone is true.
    Org string
    The name of organization to which the vApp belongs. Optional if defined at provider level.
    SharedWiths []VappAccessControlSharedWithArgs
    one or more blocks defining a subject to which we are sharing. See shared_with below for detail. It cannot be used if shared_with_everyone is set.
    VappAccessControlId string
    Vdc string
    The name of organization to which the vApp belongs. Optional if defined at provider level.
    sharedWithEveryone Boolean
    Whether the vApp is shared with everyone. If any shared_with blocks are included, this property must be set to false.
    vappId String
    A unique identifier for the vApp.
    everyoneAccessLevel String
    Access level when the vApp is shared with everyone (one of ReadOnly, Change, FullControl). Required if shared_with_everyone is true.
    org String
    The name of organization to which the vApp belongs. Optional if defined at provider level.
    sharedWiths List<VappAccessControlSharedWith>
    one or more blocks defining a subject to which we are sharing. See shared_with below for detail. It cannot be used if shared_with_everyone is set.
    vappAccessControlId String
    vdc String
    The name of organization to which the vApp belongs. Optional if defined at provider level.
    sharedWithEveryone boolean
    Whether the vApp is shared with everyone. If any shared_with blocks are included, this property must be set to false.
    vappId string
    A unique identifier for the vApp.
    everyoneAccessLevel string
    Access level when the vApp is shared with everyone (one of ReadOnly, Change, FullControl). Required if shared_with_everyone is true.
    org string
    The name of organization to which the vApp belongs. Optional if defined at provider level.
    sharedWiths VappAccessControlSharedWith[]
    one or more blocks defining a subject to which we are sharing. See shared_with below for detail. It cannot be used if shared_with_everyone is set.
    vappAccessControlId string
    vdc string
    The name of organization to which the vApp belongs. Optional if defined at provider level.
    shared_with_everyone bool
    Whether the vApp is shared with everyone. If any shared_with blocks are included, this property must be set to false.
    vapp_id str
    A unique identifier for the vApp.
    everyone_access_level str
    Access level when the vApp is shared with everyone (one of ReadOnly, Change, FullControl). Required if shared_with_everyone is true.
    org str
    The name of organization to which the vApp belongs. Optional if defined at provider level.
    shared_withs Sequence[VappAccessControlSharedWithArgs]
    one or more blocks defining a subject to which we are sharing. See shared_with below for detail. It cannot be used if shared_with_everyone is set.
    vapp_access_control_id str
    vdc str
    The name of organization to which the vApp belongs. Optional if defined at provider level.
    sharedWithEveryone Boolean
    Whether the vApp is shared with everyone. If any shared_with blocks are included, this property must be set to false.
    vappId String
    A unique identifier for the vApp.
    everyoneAccessLevel String
    Access level when the vApp is shared with everyone (one of ReadOnly, Change, FullControl). Required if shared_with_everyone is true.
    org String
    The name of organization to which the vApp belongs. Optional if defined at provider level.
    sharedWiths List<Property Map>
    one or more blocks defining a subject to which we are sharing. See shared_with below for detail. It cannot be used if shared_with_everyone is set.
    vappAccessControlId String
    vdc String
    The name of organization to which the vApp belongs. Optional if defined at provider level.

    Outputs

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

    Get an existing VappAccessControl 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?: VappAccessControlState, opts?: CustomResourceOptions): VappAccessControl
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        everyone_access_level: Optional[str] = None,
        org: Optional[str] = None,
        shared_with_everyone: Optional[bool] = None,
        shared_withs: Optional[Sequence[VappAccessControlSharedWithArgs]] = None,
        vapp_access_control_id: Optional[str] = None,
        vapp_id: Optional[str] = None,
        vdc: Optional[str] = None) -> VappAccessControl
    func GetVappAccessControl(ctx *Context, name string, id IDInput, state *VappAccessControlState, opts ...ResourceOption) (*VappAccessControl, error)
    public static VappAccessControl Get(string name, Input<string> id, VappAccessControlState? state, CustomResourceOptions? opts = null)
    public static VappAccessControl get(String name, Output<String> id, VappAccessControlState state, CustomResourceOptions options)
    resources:  _:    type: vcd:VappAccessControl    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:
    EveryoneAccessLevel string
    Access level when the vApp is shared with everyone (one of ReadOnly, Change, FullControl). Required if shared_with_everyone is true.
    Org string
    The name of organization to which the vApp belongs. Optional if defined at provider level.
    SharedWithEveryone bool
    Whether the vApp is shared with everyone. If any shared_with blocks are included, this property must be set to false.
    SharedWiths List<VappAccessControlSharedWith>
    one or more blocks defining a subject to which we are sharing. See shared_with below for detail. It cannot be used if shared_with_everyone is set.
    VappAccessControlId string
    VappId string
    A unique identifier for the vApp.
    Vdc string
    The name of organization to which the vApp belongs. Optional if defined at provider level.
    EveryoneAccessLevel string
    Access level when the vApp is shared with everyone (one of ReadOnly, Change, FullControl). Required if shared_with_everyone is true.
    Org string
    The name of organization to which the vApp belongs. Optional if defined at provider level.
    SharedWithEveryone bool
    Whether the vApp is shared with everyone. If any shared_with blocks are included, this property must be set to false.
    SharedWiths []VappAccessControlSharedWithArgs
    one or more blocks defining a subject to which we are sharing. See shared_with below for detail. It cannot be used if shared_with_everyone is set.
    VappAccessControlId string
    VappId string
    A unique identifier for the vApp.
    Vdc string
    The name of organization to which the vApp belongs. Optional if defined at provider level.
    everyoneAccessLevel String
    Access level when the vApp is shared with everyone (one of ReadOnly, Change, FullControl). Required if shared_with_everyone is true.
    org String
    The name of organization to which the vApp belongs. Optional if defined at provider level.
    sharedWithEveryone Boolean
    Whether the vApp is shared with everyone. If any shared_with blocks are included, this property must be set to false.
    sharedWiths List<VappAccessControlSharedWith>
    one or more blocks defining a subject to which we are sharing. See shared_with below for detail. It cannot be used if shared_with_everyone is set.
    vappAccessControlId String
    vappId String
    A unique identifier for the vApp.
    vdc String
    The name of organization to which the vApp belongs. Optional if defined at provider level.
    everyoneAccessLevel string
    Access level when the vApp is shared with everyone (one of ReadOnly, Change, FullControl). Required if shared_with_everyone is true.
    org string
    The name of organization to which the vApp belongs. Optional if defined at provider level.
    sharedWithEveryone boolean
    Whether the vApp is shared with everyone. If any shared_with blocks are included, this property must be set to false.
    sharedWiths VappAccessControlSharedWith[]
    one or more blocks defining a subject to which we are sharing. See shared_with below for detail. It cannot be used if shared_with_everyone is set.
    vappAccessControlId string
    vappId string
    A unique identifier for the vApp.
    vdc string
    The name of organization to which the vApp belongs. Optional if defined at provider level.
    everyone_access_level str
    Access level when the vApp is shared with everyone (one of ReadOnly, Change, FullControl). Required if shared_with_everyone is true.
    org str
    The name of organization to which the vApp belongs. Optional if defined at provider level.
    shared_with_everyone bool
    Whether the vApp is shared with everyone. If any shared_with blocks are included, this property must be set to false.
    shared_withs Sequence[VappAccessControlSharedWithArgs]
    one or more blocks defining a subject to which we are sharing. See shared_with below for detail. It cannot be used if shared_with_everyone is set.
    vapp_access_control_id str
    vapp_id str
    A unique identifier for the vApp.
    vdc str
    The name of organization to which the vApp belongs. Optional if defined at provider level.
    everyoneAccessLevel String
    Access level when the vApp is shared with everyone (one of ReadOnly, Change, FullControl). Required if shared_with_everyone is true.
    org String
    The name of organization to which the vApp belongs. Optional if defined at provider level.
    sharedWithEveryone Boolean
    Whether the vApp is shared with everyone. If any shared_with blocks are included, this property must be set to false.
    sharedWiths List<Property Map>
    one or more blocks defining a subject to which we are sharing. See shared_with below for detail. It cannot be used if shared_with_everyone is set.
    vappAccessControlId String
    vappId String
    A unique identifier for the vApp.
    vdc String
    The name of organization to which the vApp belongs. Optional if defined at provider level.

    Supporting Types

    VappAccessControlSharedWith, VappAccessControlSharedWithArgs

    AccessLevel string
    The access level for the user or group to which we are sharing. (One of ReadOnly, Change, FullControl)
    GroupId string
    The ID of a group with which we are sharing. Required if user_id is not set.
    SubjectName string
    the name of the subject (group or user) with which we are sharing.
    UserId string
    The ID of a user with which we are sharing. Required if group_id is not set.
    AccessLevel string
    The access level for the user or group to which we are sharing. (One of ReadOnly, Change, FullControl)
    GroupId string
    The ID of a group with which we are sharing. Required if user_id is not set.
    SubjectName string
    the name of the subject (group or user) with which we are sharing.
    UserId string
    The ID of a user with which we are sharing. Required if group_id is not set.
    accessLevel String
    The access level for the user or group to which we are sharing. (One of ReadOnly, Change, FullControl)
    groupId String
    The ID of a group with which we are sharing. Required if user_id is not set.
    subjectName String
    the name of the subject (group or user) with which we are sharing.
    userId String
    The ID of a user with which we are sharing. Required if group_id is not set.
    accessLevel string
    The access level for the user or group to which we are sharing. (One of ReadOnly, Change, FullControl)
    groupId string
    The ID of a group with which we are sharing. Required if user_id is not set.
    subjectName string
    the name of the subject (group or user) with which we are sharing.
    userId string
    The ID of a user with which we are sharing. Required if group_id is not set.
    access_level str
    The access level for the user or group to which we are sharing. (One of ReadOnly, Change, FullControl)
    group_id str
    The ID of a group with which we are sharing. Required if user_id is not set.
    subject_name str
    the name of the subject (group or user) with which we are sharing.
    user_id str
    The ID of a user with which we are sharing. Required if group_id is not set.
    accessLevel String
    The access level for the user or group to which we are sharing. (One of ReadOnly, Change, FullControl)
    groupId String
    The ID of a group with which we are sharing. Required if user_id is not set.
    subjectName String
    the name of the subject (group or user) with which we are sharing.
    userId String
    The ID of a user with which we are sharing. Required if group_id is not set.

    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