okta.EntitlementBundle
Manages Entitlement Bundles. This resource allows you to create and configure an Okta Entitlement Bundle.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as okta from "@pulumi/okta";
const example = new okta.EntitlementBundle("example", {name: "example"});
import pulumi
import pulumi_okta as okta
example = okta.EntitlementBundle("example", name="example")
package main
import (
"github.com/pulumi/pulumi-okta/sdk/v6/go/okta"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := okta.NewEntitlementBundle(ctx, "example", &okta.EntitlementBundleArgs{
Name: pulumi.String("example"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Okta = Pulumi.Okta;
return await Deployment.RunAsync(() =>
{
var example = new Okta.EntitlementBundle("example", new()
{
Name = "example",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.EntitlementBundle;
import com.pulumi.okta.EntitlementBundleArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new EntitlementBundle("example", EntitlementBundleArgs.builder()
.name("example")
.build());
}
}
resources:
example:
type: okta:EntitlementBundle
properties:
name: example
Create EntitlementBundle Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new EntitlementBundle(name: string, args?: EntitlementBundleArgs, opts?: CustomResourceOptions);
@overload
def EntitlementBundle(resource_name: str,
args: Optional[EntitlementBundleArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def EntitlementBundle(resource_name: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
entitlements: Optional[Sequence[EntitlementBundleEntitlementArgs]] = None,
name: Optional[str] = None,
status: Optional[str] = None,
target: Optional[EntitlementBundleTargetArgs] = None,
target_resource_orn: Optional[str] = None)
func NewEntitlementBundle(ctx *Context, name string, args *EntitlementBundleArgs, opts ...ResourceOption) (*EntitlementBundle, error)
public EntitlementBundle(string name, EntitlementBundleArgs? args = null, CustomResourceOptions? opts = null)
public EntitlementBundle(String name, EntitlementBundleArgs args)
public EntitlementBundle(String name, EntitlementBundleArgs args, CustomResourceOptions options)
type: okta:EntitlementBundle
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 EntitlementBundleArgs
- 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 EntitlementBundleArgs
- 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 EntitlementBundleArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args EntitlementBundleArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args EntitlementBundleArgs
- 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 entitlementBundleResource = new Okta.EntitlementBundle("entitlementBundleResource", new()
{
Description = "string",
Entitlements = new[]
{
new Okta.Inputs.EntitlementBundleEntitlementArgs
{
Id = "string",
Values = new[]
{
new Okta.Inputs.EntitlementBundleEntitlementValueArgs
{
Id = "string",
},
},
},
},
Name = "string",
Status = "string",
Target = new Okta.Inputs.EntitlementBundleTargetArgs
{
ExternalId = "string",
Type = "string",
},
TargetResourceOrn = "string",
});
example, err := okta.NewEntitlementBundle(ctx, "entitlementBundleResource", &okta.EntitlementBundleArgs{
Description: pulumi.String("string"),
Entitlements: okta.EntitlementBundleEntitlementArray{
&okta.EntitlementBundleEntitlementArgs{
Id: pulumi.String("string"),
Values: okta.EntitlementBundleEntitlementValueArray{
&okta.EntitlementBundleEntitlementValueArgs{
Id: pulumi.String("string"),
},
},
},
},
Name: pulumi.String("string"),
Status: pulumi.String("string"),
Target: &okta.EntitlementBundleTargetArgs{
ExternalId: pulumi.String("string"),
Type: pulumi.String("string"),
},
TargetResourceOrn: pulumi.String("string"),
})
var entitlementBundleResource = new EntitlementBundle("entitlementBundleResource", EntitlementBundleArgs.builder()
.description("string")
.entitlements(EntitlementBundleEntitlementArgs.builder()
.id("string")
.values(EntitlementBundleEntitlementValueArgs.builder()
.id("string")
.build())
.build())
.name("string")
.status("string")
.target(EntitlementBundleTargetArgs.builder()
.externalId("string")
.type("string")
.build())
.targetResourceOrn("string")
.build());
entitlement_bundle_resource = okta.EntitlementBundle("entitlementBundleResource",
description="string",
entitlements=[{
"id": "string",
"values": [{
"id": "string",
}],
}],
name="string",
status="string",
target={
"external_id": "string",
"type": "string",
},
target_resource_orn="string")
const entitlementBundleResource = new okta.EntitlementBundle("entitlementBundleResource", {
description: "string",
entitlements: [{
id: "string",
values: [{
id: "string",
}],
}],
name: "string",
status: "string",
target: {
externalId: "string",
type: "string",
},
targetResourceOrn: "string",
});
type: okta:EntitlementBundle
properties:
description: string
entitlements:
- id: string
values:
- id: string
name: string
status: string
target:
externalId: string
type: string
targetResourceOrn: string
EntitlementBundle 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 EntitlementBundle resource accepts the following input properties:
- Description string
- The description of an entitlement property.
- Entitlements
List<Entitlement
Bundle Entitlement> - List of entitlements in the bundle
- Name string
- The display name for an entitlement bundle.
- Status string
- The status of the entitlement bundle.
- Target
Entitlement
Bundle Target - Representation of a resource
- Target
Resource stringOrn - The ORN of the target resource. Required when updating the entitlement bundle.
- Description string
- The description of an entitlement property.
- Entitlements
[]Entitlement
Bundle Entitlement Args - List of entitlements in the bundle
- Name string
- The display name for an entitlement bundle.
- Status string
- The status of the entitlement bundle.
- Target
Entitlement
Bundle Target Args - Representation of a resource
- Target
Resource stringOrn - The ORN of the target resource. Required when updating the entitlement bundle.
- description String
- The description of an entitlement property.
- entitlements
List<Entitlement
Bundle Entitlement> - List of entitlements in the bundle
- name String
- The display name for an entitlement bundle.
- status String
- The status of the entitlement bundle.
- target
Entitlement
Bundle Target - Representation of a resource
- target
Resource StringOrn - The ORN of the target resource. Required when updating the entitlement bundle.
- description string
- The description of an entitlement property.
- entitlements
Entitlement
Bundle Entitlement[] - List of entitlements in the bundle
- name string
- The display name for an entitlement bundle.
- status string
- The status of the entitlement bundle.
- target
Entitlement
Bundle Target - Representation of a resource
- target
Resource stringOrn - The ORN of the target resource. Required when updating the entitlement bundle.
- description str
- The description of an entitlement property.
- entitlements
Sequence[Entitlement
Bundle Entitlement Args] - List of entitlements in the bundle
- name str
- The display name for an entitlement bundle.
- status str
- The status of the entitlement bundle.
- target
Entitlement
Bundle Target Args - Representation of a resource
- target_
resource_ strorn - The ORN of the target resource. Required when updating the entitlement bundle.
- description String
- The description of an entitlement property.
- entitlements List<Property Map>
- List of entitlements in the bundle
- name String
- The display name for an entitlement bundle.
- status String
- The status of the entitlement bundle.
- target Property Map
- Representation of a resource
- target
Resource StringOrn - The ORN of the target resource. Required when updating the entitlement bundle.
Outputs
All input properties are implicitly available as output properties. Additionally, the EntitlementBundle 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 EntitlementBundle Resource
Get an existing EntitlementBundle 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?: EntitlementBundleState, opts?: CustomResourceOptions): EntitlementBundle
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
entitlements: Optional[Sequence[EntitlementBundleEntitlementArgs]] = None,
name: Optional[str] = None,
status: Optional[str] = None,
target: Optional[EntitlementBundleTargetArgs] = None,
target_resource_orn: Optional[str] = None) -> EntitlementBundle
func GetEntitlementBundle(ctx *Context, name string, id IDInput, state *EntitlementBundleState, opts ...ResourceOption) (*EntitlementBundle, error)
public static EntitlementBundle Get(string name, Input<string> id, EntitlementBundleState? state, CustomResourceOptions? opts = null)
public static EntitlementBundle get(String name, Output<String> id, EntitlementBundleState state, CustomResourceOptions options)
resources: _: type: okta:EntitlementBundle 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.
- Description string
- The description of an entitlement property.
- Entitlements
List<Entitlement
Bundle Entitlement> - List of entitlements in the bundle
- Name string
- The display name for an entitlement bundle.
- Status string
- The status of the entitlement bundle.
- Target
Entitlement
Bundle Target - Representation of a resource
- Target
Resource stringOrn - The ORN of the target resource. Required when updating the entitlement bundle.
- Description string
- The description of an entitlement property.
- Entitlements
[]Entitlement
Bundle Entitlement Args - List of entitlements in the bundle
- Name string
- The display name for an entitlement bundle.
- Status string
- The status of the entitlement bundle.
- Target
Entitlement
Bundle Target Args - Representation of a resource
- Target
Resource stringOrn - The ORN of the target resource. Required when updating the entitlement bundle.
- description String
- The description of an entitlement property.
- entitlements
List<Entitlement
Bundle Entitlement> - List of entitlements in the bundle
- name String
- The display name for an entitlement bundle.
- status String
- The status of the entitlement bundle.
- target
Entitlement
Bundle Target - Representation of a resource
- target
Resource StringOrn - The ORN of the target resource. Required when updating the entitlement bundle.
- description string
- The description of an entitlement property.
- entitlements
Entitlement
Bundle Entitlement[] - List of entitlements in the bundle
- name string
- The display name for an entitlement bundle.
- status string
- The status of the entitlement bundle.
- target
Entitlement
Bundle Target - Representation of a resource
- target
Resource stringOrn - The ORN of the target resource. Required when updating the entitlement bundle.
- description str
- The description of an entitlement property.
- entitlements
Sequence[Entitlement
Bundle Entitlement Args] - List of entitlements in the bundle
- name str
- The display name for an entitlement bundle.
- status str
- The status of the entitlement bundle.
- target
Entitlement
Bundle Target Args - Representation of a resource
- target_
resource_ strorn - The ORN of the target resource. Required when updating the entitlement bundle.
- description String
- The description of an entitlement property.
- entitlements List<Property Map>
- List of entitlements in the bundle
- name String
- The display name for an entitlement bundle.
- status String
- The status of the entitlement bundle.
- target Property Map
- Representation of a resource
- target
Resource StringOrn - The ORN of the target resource. Required when updating the entitlement bundle.
Supporting Types
EntitlementBundleEntitlement, EntitlementBundleEntitlementArgs
- Id string
- The ID of the entitlement.
- Values
List<Entitlement
Bundle Entitlement Value>
- Id string
- The ID of the entitlement.
- Values
[]Entitlement
Bundle Entitlement Value
- id String
- The ID of the entitlement.
- values
List<Entitlement
Bundle Entitlement Value>
- id string
- The ID of the entitlement.
- values
Entitlement
Bundle Entitlement Value[]
- id str
- The ID of the entitlement.
- values
Sequence[Entitlement
Bundle Entitlement Value]
- id String
- The ID of the entitlement.
- values List<Property Map>
EntitlementBundleEntitlementValue, EntitlementBundleEntitlementValueArgs
- Id string
- The ID of the entitlement value.
- Id string
- The ID of the entitlement value.
- id String
- The ID of the entitlement value.
- id string
- The ID of the entitlement value.
- id str
- The ID of the entitlement value.
- id String
- The ID of the entitlement value.
EntitlementBundleTarget, EntitlementBundleTargetArgs
- External
Id string - The Okta app ID of the resource.
- Type string
- The type of resource.
- External
Id string - The Okta app ID of the resource.
- Type string
- The type of resource.
- external
Id String - The Okta app ID of the resource.
- type String
- The type of resource.
- external
Id string - The Okta app ID of the resource.
- type string
- The type of resource.
- external_
id str - The Okta app ID of the resource.
- type str
- The type of resource.
- external
Id String - The Okta app ID of the resource.
- type String
- The type of resource.
Import
$ pulumi import okta:index/entitlementBundle:EntitlementBundle example <entitlement_bundle_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.