Docs Packages
  1. Packages
  2. FusionAuth
  3. API Docs
  4. FusionAuthEntityTypePermission
FusionAuth v4.0.1 published on Saturday, Sep 30, 2023 by Theo Gravity
theogravity/pulumi-fusionauth

fusionauth.FusionAuthEntityTypePermission

Explore with Pulumi AI

fusionauth logo
FusionAuth v4.0.1 published on Saturday, Sep 30, 2023 by Theo Gravity
theogravity/pulumi-fusionauth

    Create FusionAuthEntityTypePermission Resource

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

    Constructor syntax

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

@overload
def FusionAuthEntityTypePermission(resource_name: str,
                                   opts: Optional[ResourceOptions] = None,
                                   entity_type_id: Optional[str] = None,
                                   data: Optional[str] = None,
                                   description: Optional[str] = None,
                                   is_default: Optional[bool] = None,
                                   name: Optional[str] = None,
                                   permission_id: Optional[str] = None)
    func NewFusionAuthEntityTypePermission(ctx *Context, name string, args FusionAuthEntityTypePermissionArgs, opts ...ResourceOption) (*FusionAuthEntityTypePermission, error)
    public FusionAuthEntityTypePermission(string name, FusionAuthEntityTypePermissionArgs args, CustomResourceOptions? opts = null)
    public FusionAuthEntityTypePermission(String name, FusionAuthEntityTypePermissionArgs args)
public FusionAuthEntityTypePermission(String name, FusionAuthEntityTypePermissionArgs args, CustomResourceOptions options)

    type: fusionauth:FusionAuthEntityTypePermission
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 FusionAuthEntityTypePermissionArgs
    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 FusionAuthEntityTypePermissionArgs
    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 FusionAuthEntityTypePermissionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FusionAuthEntityTypePermissionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FusionAuthEntityTypePermissionArgs
    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 fusionAuthEntityTypePermissionResource = new Fusionauth.FusionAuthEntityTypePermission("fusionAuthEntityTypePermissionResource", new()
{
    EntityTypeId = "string",
    Data = "string",
    Description = "string",
    IsDefault = false,
    Name = "string",
    PermissionId = "string",
});

    example, err := fusionauth.NewFusionAuthEntityTypePermission(ctx, "fusionAuthEntityTypePermissionResource", &fusionauth.FusionAuthEntityTypePermissionArgs{
	EntityTypeId: pulumi.String("string"),
	Data:         pulumi.String("string"),
	Description:  pulumi.String("string"),
	IsDefault:    pulumi.Bool(false),
	Name:         pulumi.String("string"),
	PermissionId: pulumi.String("string"),
})

    var fusionAuthEntityTypePermissionResource = new FusionAuthEntityTypePermission("fusionAuthEntityTypePermissionResource", FusionAuthEntityTypePermissionArgs.builder()
    .entityTypeId("string")
    .data("string")
    .description("string")
    .isDefault(false)
    .name("string")
    .permissionId("string")
    .build());

    fusion_auth_entity_type_permission_resource = fusionauth.FusionAuthEntityTypePermission("fusionAuthEntityTypePermissionResource",
    entity_type_id="string",
    data="string",
    description="string",
    is_default=False,
    name="string",
    permission_id="string")

    const fusionAuthEntityTypePermissionResource = new fusionauth.FusionAuthEntityTypePermission("fusionAuthEntityTypePermissionResource", {
    entityTypeId: "string",
    data: "string",
    description: "string",
    isDefault: false,
    name: "string",
    permissionId: "string",
});

    type: fusionauth:FusionAuthEntityTypePermission
properties:
    data: string
    description: string
    entityTypeId: string
    isDefault: false
    name: string
    permissionId: string

    FusionAuthEntityTypePermission Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The FusionAuthEntityTypePermission resource accepts the following input properties:

    EntityTypeId string
    The Id of the Entity Type.
    Data string
    An object that can hold any information about the Permission that should be persisted. Must be a JSON string.
    Description string
    The description of the Permission.
    IsDefault bool
    Whether or not the Permission is a default permission. A default permission is automatically granted to an entity of this type if no permissions are provided in a grant request.
    Name string
    The name of the Permission.
    PermissionId string
    The Id to use for the new permission. If not specified a secure random UUID will be generated.
    EntityTypeId string
    The Id of the Entity Type.
    Data string
    An object that can hold any information about the Permission that should be persisted. Must be a JSON string.
    Description string
    The description of the Permission.
    IsDefault bool
    Whether or not the Permission is a default permission. A default permission is automatically granted to an entity of this type if no permissions are provided in a grant request.
    Name string
    The name of the Permission.
    PermissionId string
    The Id to use for the new permission. If not specified a secure random UUID will be generated.
    entityTypeId String
    The Id of the Entity Type.
    data String
    An object that can hold any information about the Permission that should be persisted. Must be a JSON string.
    description String
    The description of the Permission.
    isDefault Boolean
    Whether or not the Permission is a default permission. A default permission is automatically granted to an entity of this type if no permissions are provided in a grant request.
    name String
    The name of the Permission.
    permissionId String
    The Id to use for the new permission. If not specified a secure random UUID will be generated.
    entityTypeId string
    The Id of the Entity Type.
    data string
    An object that can hold any information about the Permission that should be persisted. Must be a JSON string.
    description string
    The description of the Permission.
    isDefault boolean
    Whether or not the Permission is a default permission. A default permission is automatically granted to an entity of this type if no permissions are provided in a grant request.
    name string
    The name of the Permission.
    permissionId string
    The Id to use for the new permission. If not specified a secure random UUID will be generated.
    entity_type_id str
    The Id of the Entity Type.
    data str
    An object that can hold any information about the Permission that should be persisted. Must be a JSON string.
    description str
    The description of the Permission.
    is_default bool
    Whether or not the Permission is a default permission. A default permission is automatically granted to an entity of this type if no permissions are provided in a grant request.
    name str
    The name of the Permission.
    permission_id str
    The Id to use for the new permission. If not specified a secure random UUID will be generated.
    entityTypeId String
    The Id of the Entity Type.
    data String
    An object that can hold any information about the Permission that should be persisted. Must be a JSON string.
    description String
    The description of the Permission.
    isDefault Boolean
    Whether or not the Permission is a default permission. A default permission is automatically granted to an entity of this type if no permissions are provided in a grant request.
    name String
    The name of the Permission.
    permissionId String
    The Id to use for the new permission. If not specified a secure random UUID will be generated.

    Outputs

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

    Get an existing FusionAuthEntityTypePermission 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?: FusionAuthEntityTypePermissionState, opts?: CustomResourceOptions): FusionAuthEntityTypePermission
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        data: Optional[str] = None,
        description: Optional[str] = None,
        entity_type_id: Optional[str] = None,
        is_default: Optional[bool] = None,
        name: Optional[str] = None,
        permission_id: Optional[str] = None) -> FusionAuthEntityTypePermission
    func GetFusionAuthEntityTypePermission(ctx *Context, name string, id IDInput, state *FusionAuthEntityTypePermissionState, opts ...ResourceOption) (*FusionAuthEntityTypePermission, error)
    public static FusionAuthEntityTypePermission Get(string name, Input<string> id, FusionAuthEntityTypePermissionState? state, CustomResourceOptions? opts = null)
    public static FusionAuthEntityTypePermission get(String name, Output<String> id, FusionAuthEntityTypePermissionState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    Data string
    An object that can hold any information about the Permission that should be persisted. Must be a JSON string.
    Description string
    The description of the Permission.
    EntityTypeId string
    The Id of the Entity Type.
    IsDefault bool
    Whether or not the Permission is a default permission. A default permission is automatically granted to an entity of this type if no permissions are provided in a grant request.
    Name string
    The name of the Permission.
    PermissionId string
    The Id to use for the new permission. If not specified a secure random UUID will be generated.
    Data string
    An object that can hold any information about the Permission that should be persisted. Must be a JSON string.
    Description string
    The description of the Permission.
    EntityTypeId string
    The Id of the Entity Type.
    IsDefault bool
    Whether or not the Permission is a default permission. A default permission is automatically granted to an entity of this type if no permissions are provided in a grant request.
    Name string
    The name of the Permission.
    PermissionId string
    The Id to use for the new permission. If not specified a secure random UUID will be generated.
    data String
    An object that can hold any information about the Permission that should be persisted. Must be a JSON string.
    description String
    The description of the Permission.
    entityTypeId String
    The Id of the Entity Type.
    isDefault Boolean
    Whether or not the Permission is a default permission. A default permission is automatically granted to an entity of this type if no permissions are provided in a grant request.
    name String
    The name of the Permission.
    permissionId String
    The Id to use for the new permission. If not specified a secure random UUID will be generated.
    data string
    An object that can hold any information about the Permission that should be persisted. Must be a JSON string.
    description string
    The description of the Permission.
    entityTypeId string
    The Id of the Entity Type.
    isDefault boolean
    Whether or not the Permission is a default permission. A default permission is automatically granted to an entity of this type if no permissions are provided in a grant request.
    name string
    The name of the Permission.
    permissionId string
    The Id to use for the new permission. If not specified a secure random UUID will be generated.
    data str
    An object that can hold any information about the Permission that should be persisted. Must be a JSON string.
    description str
    The description of the Permission.
    entity_type_id str
    The Id of the Entity Type.
    is_default bool
    Whether or not the Permission is a default permission. A default permission is automatically granted to an entity of this type if no permissions are provided in a grant request.
    name str
    The name of the Permission.
    permission_id str
    The Id to use for the new permission. If not specified a secure random UUID will be generated.
    data String
    An object that can hold any information about the Permission that should be persisted. Must be a JSON string.
    description String
    The description of the Permission.
    entityTypeId String
    The Id of the Entity Type.
    isDefault Boolean
    Whether or not the Permission is a default permission. A default permission is automatically granted to an entity of this type if no permissions are provided in a grant request.
    name String
    The name of the Permission.
    permissionId String
    The Id to use for the new permission. If not specified a secure random UUID will be generated.

    Package Details

    Repository
    fusionauth theogravity/pulumi-fusionauth
    License
    MIT
    Notes
    This Pulumi package is based on the fusionauth Terraform Provider.
    fusionauth logo
    FusionAuth v4.0.1 published on Saturday, Sep 30, 2023 by Theo Gravity
    theogravity/pulumi-fusionauth