Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Okta Provider
  3. API Docs
  4. ResourceSet
Okta v4.11.3 published on Monday, Oct 21, 2024 by Pulumi
pulumi/pulumi-okta

okta.ResourceSet

Explore with Pulumi AI

okta logo
Okta v4.11.3 published on Monday, Oct 21, 2024 by Pulumi
pulumi/pulumi-okta

    Manages Resource Sets as custom collections of resources. This resource allows the creation and manipulation of Okta Resource Sets as custom collections of Okta resources. You can use Okta Resource Sets to assign Custom Roles to administrators who are scoped to the designated resources. The ‘resources’ field supports the following: - Apps - Groups - All Users within a Group - All Users within the org - All Groups within the org - All Apps within the org - All Apps of the same type

    Create ResourceSet Resource

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

    Constructor syntax

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

@overload
def ResourceSet(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                description: Optional[str] = None,
                label: Optional[str] = None,
                resources: Optional[Sequence[str]] = None)
    func NewResourceSet(ctx *Context, name string, args ResourceSetArgs, opts ...ResourceOption) (*ResourceSet, error)
    public ResourceSet(string name, ResourceSetArgs args, CustomResourceOptions? opts = null)
    public ResourceSet(String name, ResourceSetArgs args)
public ResourceSet(String name, ResourceSetArgs args, CustomResourceOptions options)

    type: okta:ResourceSet
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 ResourceSetArgs
    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 ResourceSetArgs
    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 ResourceSetArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ResourceSetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ResourceSetArgs
    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 resourceSetResource = new Okta.ResourceSet("resourceSetResource", new()
{
    Description = "string",
    Label = "string",
    Resources = new[]
    {
        "string",
    },
});

    example, err := okta.NewResourceSet(ctx, "resourceSetResource", &okta.ResourceSetArgs{
	Description: pulumi.String("string"),
	Label:       pulumi.String("string"),
	Resources: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var resourceSetResource = new ResourceSet("resourceSetResource", ResourceSetArgs.builder()
    .description("string")
    .label("string")
    .resources("string")
    .build());

    resource_set_resource = okta.ResourceSet("resourceSetResource",
    description="string",
    label="string",
    resources=["string"])

    const resourceSetResource = new okta.ResourceSet("resourceSetResource", {
    description: "string",
    label: "string",
    resources: ["string"],
});

    type: okta:ResourceSet
properties:
    description: string
    label: string
    resources:
        - string

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

    Description string
    A description of the Resource Set
    Label string
    Unique name given to the Resource Set
    Resources List<string>
    The endpoints that reference the resources to be included in the new Resource Set. At least one endpoint must be specified when creating resource set.
    Description string
    A description of the Resource Set
    Label string
    Unique name given to the Resource Set
    Resources []string
    The endpoints that reference the resources to be included in the new Resource Set. At least one endpoint must be specified when creating resource set.
    description String
    A description of the Resource Set
    label String
    Unique name given to the Resource Set
    resources List<String>
    The endpoints that reference the resources to be included in the new Resource Set. At least one endpoint must be specified when creating resource set.
    description string
    A description of the Resource Set
    label string
    Unique name given to the Resource Set
    resources string[]
    The endpoints that reference the resources to be included in the new Resource Set. At least one endpoint must be specified when creating resource set.
    description str
    A description of the Resource Set
    label str
    Unique name given to the Resource Set
    resources Sequence[str]
    The endpoints that reference the resources to be included in the new Resource Set. At least one endpoint must be specified when creating resource set.
    description String
    A description of the Resource Set
    label String
    Unique name given to the Resource Set
    resources List<String>
    The endpoints that reference the resources to be included in the new Resource Set. At least one endpoint must be specified when creating resource set.

    Outputs

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

    Get an existing ResourceSet 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?: ResourceSetState, opts?: CustomResourceOptions): ResourceSet
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        label: Optional[str] = None,
        resources: Optional[Sequence[str]] = None) -> ResourceSet
    func GetResourceSet(ctx *Context, name string, id IDInput, state *ResourceSetState, opts ...ResourceOption) (*ResourceSet, error)
    public static ResourceSet Get(string name, Input<string> id, ResourceSetState? state, CustomResourceOptions? opts = null)
    public static ResourceSet get(String name, Output<String> id, ResourceSetState 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:
    Description string
    A description of the Resource Set
    Label string
    Unique name given to the Resource Set
    Resources List<string>
    The endpoints that reference the resources to be included in the new Resource Set. At least one endpoint must be specified when creating resource set.
    Description string
    A description of the Resource Set
    Label string
    Unique name given to the Resource Set
    Resources []string
    The endpoints that reference the resources to be included in the new Resource Set. At least one endpoint must be specified when creating resource set.
    description String
    A description of the Resource Set
    label String
    Unique name given to the Resource Set
    resources List<String>
    The endpoints that reference the resources to be included in the new Resource Set. At least one endpoint must be specified when creating resource set.
    description string
    A description of the Resource Set
    label string
    Unique name given to the Resource Set
    resources string[]
    The endpoints that reference the resources to be included in the new Resource Set. At least one endpoint must be specified when creating resource set.
    description str
    A description of the Resource Set
    label str
    Unique name given to the Resource Set
    resources Sequence[str]
    The endpoints that reference the resources to be included in the new Resource Set. At least one endpoint must be specified when creating resource set.
    description String
    A description of the Resource Set
    label String
    Unique name given to the Resource Set
    resources List<String>
    The endpoints that reference the resources to be included in the new Resource Set. At least one endpoint must be specified when creating resource set.

    Import

    $ pulumi import okta:index/resourceSet:ResourceSet example <resource_set_id>

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Okta pulumi/pulumi-okta
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the okta Terraform Provider.
    okta logo
    Okta v4.11.3 published on Monday, Oct 21, 2024 by Pulumi
    pulumi/pulumi-okta