1. Packages
  2. Okta
  3. API Docs
  4. PolicyProfileEnrollment
Okta v4.8.0 published on Saturday, Mar 2, 2024 by Pulumi

okta.PolicyProfileEnrollment

Explore with Pulumi AI

okta logo
Okta v4.8.0 published on Saturday, Mar 2, 2024 by Pulumi

    WARNING: This feature is only available as a part of the Identity Engine. Contact support for further information.

    This resource allows you to create and configure a Profile Enrollment Policy.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Okta = Pulumi.Okta;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Okta.PolicyProfileEnrollment("example", new()
        {
            Status = "ACTIVE",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-okta/sdk/v4/go/okta"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := okta.NewPolicyProfileEnrollment(ctx, "example", &okta.PolicyProfileEnrollmentArgs{
    			Status: pulumi.String("ACTIVE"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.okta.PolicyProfileEnrollment;
    import com.pulumi.okta.PolicyProfileEnrollmentArgs;
    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 PolicyProfileEnrollment("example", PolicyProfileEnrollmentArgs.builder()        
                .status("ACTIVE")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_okta as okta
    
    example = okta.PolicyProfileEnrollment("example", status="ACTIVE")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as okta from "@pulumi/okta";
    
    const example = new okta.PolicyProfileEnrollment("example", {status: "ACTIVE"});
    
    resources:
      example:
        type: okta:PolicyProfileEnrollment
        properties:
          status: ACTIVE
    

    Create PolicyProfileEnrollment Resource

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

    Constructor syntax

    new PolicyProfileEnrollment(name: string, args?: PolicyProfileEnrollmentArgs, opts?: CustomResourceOptions);
    @overload
    def PolicyProfileEnrollment(resource_name: str,
                                args: Optional[PolicyProfileEnrollmentArgs] = None,
                                opts: Optional[ResourceOptions] = None)
    
    @overload
    def PolicyProfileEnrollment(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                name: Optional[str] = None,
                                status: Optional[str] = None)
    func NewPolicyProfileEnrollment(ctx *Context, name string, args *PolicyProfileEnrollmentArgs, opts ...ResourceOption) (*PolicyProfileEnrollment, error)
    public PolicyProfileEnrollment(string name, PolicyProfileEnrollmentArgs? args = null, CustomResourceOptions? opts = null)
    public PolicyProfileEnrollment(String name, PolicyProfileEnrollmentArgs args)
    public PolicyProfileEnrollment(String name, PolicyProfileEnrollmentArgs args, CustomResourceOptions options)
    
    type: okta:PolicyProfileEnrollment
    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 PolicyProfileEnrollmentArgs
    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 PolicyProfileEnrollmentArgs
    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 PolicyProfileEnrollmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicyProfileEnrollmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicyProfileEnrollmentArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var policyProfileEnrollmentResource = new Okta.PolicyProfileEnrollment("policyProfileEnrollmentResource", new()
    {
        Name = "string",
        Status = "string",
    });
    
    example, err := okta.NewPolicyProfileEnrollment(ctx, "policyProfileEnrollmentResource", &okta.PolicyProfileEnrollmentArgs{
    	Name:   pulumi.String("string"),
    	Status: pulumi.String("string"),
    })
    
    var policyProfileEnrollmentResource = new PolicyProfileEnrollment("policyProfileEnrollmentResource", PolicyProfileEnrollmentArgs.builder()        
        .name("string")
        .status("string")
        .build());
    
    policy_profile_enrollment_resource = okta.PolicyProfileEnrollment("policyProfileEnrollmentResource",
        name="string",
        status="string")
    
    const policyProfileEnrollmentResource = new okta.PolicyProfileEnrollment("policyProfileEnrollmentResource", {
        name: "string",
        status: "string",
    });
    
    type: okta:PolicyProfileEnrollment
    properties:
        name: string
        status: string
    

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

    Name string
    Policy Name.
    Status string
    Status of the policy.
    Name string
    Policy Name.
    Status string
    Status of the policy.
    name String
    Policy Name.
    status String
    Status of the policy.
    name string
    Policy Name.
    status string
    Status of the policy.
    name str
    Policy Name.
    status str
    Status of the policy.
    name String
    Policy Name.
    status String
    Status of the policy.

    Outputs

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

    Get an existing PolicyProfileEnrollment 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?: PolicyProfileEnrollmentState, opts?: CustomResourceOptions): PolicyProfileEnrollment
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            name: Optional[str] = None,
            status: Optional[str] = None) -> PolicyProfileEnrollment
    func GetPolicyProfileEnrollment(ctx *Context, name string, id IDInput, state *PolicyProfileEnrollmentState, opts ...ResourceOption) (*PolicyProfileEnrollment, error)
    public static PolicyProfileEnrollment Get(string name, Input<string> id, PolicyProfileEnrollmentState? state, CustomResourceOptions? opts = null)
    public static PolicyProfileEnrollment get(String name, Output<String> id, PolicyProfileEnrollmentState 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:
    Name string
    Policy Name.
    Status string
    Status of the policy.
    Name string
    Policy Name.
    Status string
    Status of the policy.
    name String
    Policy Name.
    status String
    Status of the policy.
    name string
    Policy Name.
    status string
    Status of the policy.
    name str
    Policy Name.
    status str
    Status of the policy.
    name String
    Policy Name.
    status String
    Status of the policy.

    Import

    A Profile Enrollment Policy can be imported via the Okta ID.

    $ pulumi import okta:index/policyProfileEnrollment:PolicyProfileEnrollment example &#60;policy id&#62;
    

    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.8.0 published on Saturday, Mar 2, 2024 by Pulumi