Docs Packages
  1. Packages
  2. Control Plane (cpln)
  3. API Docs
  4. Org
Control Plane v0.0.27 published on Saturday, May 25, 2024 by pulumiverse
pulumiverse/pulumi-cpln

cpln.Org

Explore with Pulumi AI

cpln logo
Control Plane v0.0.27 published on Saturday, May 25, 2024 by pulumiverse
pulumiverse/pulumi-cpln

    Create Org Resource

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

    Constructor syntax

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

@overload
def Org(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        observability: Optional[OrgObservabilityArgs] = None,
        account_id: Optional[str] = None,
        auth_config: Optional[OrgAuthConfigArgs] = None,
        description: Optional[str] = None,
        invitees: Optional[Sequence[str]] = None,
        security: Optional[OrgSecurityArgs] = None,
        session_timeout_seconds: Optional[int] = None,
        tags: Optional[Mapping[str, str]] = None)
    func NewOrg(ctx *Context, name string, args OrgArgs, opts ...ResourceOption) (*Org, error)
    public Org(string name, OrgArgs args, CustomResourceOptions? opts = null)
    public Org(String name, OrgArgs args)
public Org(String name, OrgArgs args, CustomResourceOptions options)

    type: cpln:Org
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 OrgArgs
    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 OrgArgs
    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 OrgArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OrgArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OrgArgs
    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 orgResource = new Cpln.Org("orgResource", new()
{
    Observability = new Cpln.Inputs.OrgObservabilityArgs
    {
        LogsRetentionDays = 0,
        MetricsRetentionDays = 0,
        TracesRetentionDays = 0,
    },
    AccountId = "string",
    AuthConfig = new Cpln.Inputs.OrgAuthConfigArgs
    {
        DomainAutoMembers = new[]
        {
            "string",
        },
        SamlOnly = false,
    },
    Description = "string",
    Invitees = new[]
    {
        "string",
    },
    Security = new Cpln.Inputs.OrgSecurityArgs
    {
        ThreatDetection = new Cpln.Inputs.OrgSecurityThreatDetectionArgs
        {
            Enabled = false,
            MinimumSeverity = "string",
            Syslog = new Cpln.Inputs.OrgSecurityThreatDetectionSyslogArgs
            {
                Port = 0,
                Host = "string",
                Transport = "string",
            },
        },
    },
    SessionTimeoutSeconds = 0,
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := cpln.NewOrg(ctx, "orgResource", &cpln.OrgArgs{
	Observability: &cpln.OrgObservabilityArgs{
		LogsRetentionDays:    pulumi.Int(0),
		MetricsRetentionDays: pulumi.Int(0),
		TracesRetentionDays:  pulumi.Int(0),
	},
	AccountId: pulumi.String("string"),
	AuthConfig: &cpln.OrgAuthConfigArgs{
		DomainAutoMembers: pulumi.StringArray{
			pulumi.String("string"),
		},
		SamlOnly: pulumi.Bool(false),
	},
	Description: pulumi.String("string"),
	Invitees: pulumi.StringArray{
		pulumi.String("string"),
	},
	Security: &cpln.OrgSecurityArgs{
		ThreatDetection: &cpln.OrgSecurityThreatDetectionArgs{
			Enabled:         pulumi.Bool(false),
			MinimumSeverity: pulumi.String("string"),
			Syslog: &cpln.OrgSecurityThreatDetectionSyslogArgs{
				Port:      pulumi.Int(0),
				Host:      pulumi.String("string"),
				Transport: pulumi.String("string"),
			},
		},
	},
	SessionTimeoutSeconds: pulumi.Int(0),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var orgResource = new Org("orgResource", OrgArgs.builder()
    .observability(OrgObservabilityArgs.builder()
        .logsRetentionDays(0)
        .metricsRetentionDays(0)
        .tracesRetentionDays(0)
        .build())
    .accountId("string")
    .authConfig(OrgAuthConfigArgs.builder()
        .domainAutoMembers("string")
        .samlOnly(false)
        .build())
    .description("string")
    .invitees("string")
    .security(OrgSecurityArgs.builder()
        .threatDetection(OrgSecurityThreatDetectionArgs.builder()
            .enabled(false)
            .minimumSeverity("string")
            .syslog(OrgSecurityThreatDetectionSyslogArgs.builder()
                .port(0)
                .host("string")
                .transport("string")
                .build())
            .build())
        .build())
    .sessionTimeoutSeconds(0)
    .tags(Map.of("string", "string"))
    .build());

    org_resource = cpln.Org("orgResource",
    observability=cpln.OrgObservabilityArgs(
        logs_retention_days=0,
        metrics_retention_days=0,
        traces_retention_days=0,
    ),
    account_id="string",
    auth_config=cpln.OrgAuthConfigArgs(
        domain_auto_members=["string"],
        saml_only=False,
    ),
    description="string",
    invitees=["string"],
    security=cpln.OrgSecurityArgs(
        threat_detection=cpln.OrgSecurityThreatDetectionArgs(
            enabled=False,
            minimum_severity="string",
            syslog=cpln.OrgSecurityThreatDetectionSyslogArgs(
                port=0,
                host="string",
                transport="string",
            ),
        ),
    ),
    session_timeout_seconds=0,
    tags={
        "string": "string",
    })

    const orgResource = new cpln.Org("orgResource", {
    observability: {
        logsRetentionDays: 0,
        metricsRetentionDays: 0,
        tracesRetentionDays: 0,
    },
    accountId: "string",
    authConfig: {
        domainAutoMembers: ["string"],
        samlOnly: false,
    },
    description: "string",
    invitees: ["string"],
    security: {
        threatDetection: {
            enabled: false,
            minimumSeverity: "string",
            syslog: {
                port: 0,
                host: "string",
                transport: "string",
            },
        },
    },
    sessionTimeoutSeconds: 0,
    tags: {
        string: "string",
    },
});

    type: cpln:Org
properties:
    accountId: string
    authConfig:
        domainAutoMembers:
            - string
        samlOnly: false
    description: string
    invitees:
        - string
    observability:
        logsRetentionDays: 0
        metricsRetentionDays: 0
        tracesRetentionDays: 0
    security:
        threatDetection:
            enabled: false
            minimumSeverity: string
            syslog:
                host: string
                port: 0
                transport: string
    sessionTimeoutSeconds: 0
    tags:
        string: string

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

    Observability Pulumiverse.Cpln.Inputs.OrgObservability
    The retention period (in days) for logs, metrics, and traces. Charges apply for storage beyond the 30 day default.
    AccountId string
    The associated account ID that will be used when creating the org. Only used on org creation. The account ID can be obtained from the Org Management & Billing page.
    AuthConfig Pulumiverse.Cpln.Inputs.OrgAuthConfig
    The configuration settings and parameters related to authentication within the org.
    Description string
    The description of org.
    Invitees List<string>
    When an org is created, the list of email addresses which will receive an invitation to join the org and be assigned to the superusers group. The user account used when creating the org will be included in this list.
    Security Pulumiverse.Cpln.Inputs.OrgSecurity
    SessionTimeoutSeconds int
    The idle time (in seconds) in which the console UI will automatically sign-out the user. Default: 900 (15 minutes)
    Tags Dictionary<string, string>
    Key-value map of the org's tags.
    Observability OrgObservabilityArgs
    The retention period (in days) for logs, metrics, and traces. Charges apply for storage beyond the 30 day default.
    AccountId string
    The associated account ID that will be used when creating the org. Only used on org creation. The account ID can be obtained from the Org Management & Billing page.
    AuthConfig OrgAuthConfigArgs
    The configuration settings and parameters related to authentication within the org.
    Description string
    The description of org.
    Invitees []string
    When an org is created, the list of email addresses which will receive an invitation to join the org and be assigned to the superusers group. The user account used when creating the org will be included in this list.
    Security OrgSecurityArgs
    SessionTimeoutSeconds int
    The idle time (in seconds) in which the console UI will automatically sign-out the user. Default: 900 (15 minutes)
    Tags map[string]string
    Key-value map of the org's tags.
    observability OrgObservability
    The retention period (in days) for logs, metrics, and traces. Charges apply for storage beyond the 30 day default.
    accountId String
    The associated account ID that will be used when creating the org. Only used on org creation. The account ID can be obtained from the Org Management & Billing page.
    authConfig OrgAuthConfig
    The configuration settings and parameters related to authentication within the org.
    description String
    The description of org.
    invitees List<String>
    When an org is created, the list of email addresses which will receive an invitation to join the org and be assigned to the superusers group. The user account used when creating the org will be included in this list.
    security OrgSecurity
    sessionTimeoutSeconds Integer
    The idle time (in seconds) in which the console UI will automatically sign-out the user. Default: 900 (15 minutes)
    tags Map<String,String>
    Key-value map of the org's tags.
    observability OrgObservability
    The retention period (in days) for logs, metrics, and traces. Charges apply for storage beyond the 30 day default.
    accountId string
    The associated account ID that will be used when creating the org. Only used on org creation. The account ID can be obtained from the Org Management & Billing page.
    authConfig OrgAuthConfig
    The configuration settings and parameters related to authentication within the org.
    description string
    The description of org.
    invitees string[]
    When an org is created, the list of email addresses which will receive an invitation to join the org and be assigned to the superusers group. The user account used when creating the org will be included in this list.
    security OrgSecurity
    sessionTimeoutSeconds number
    The idle time (in seconds) in which the console UI will automatically sign-out the user. Default: 900 (15 minutes)
    tags {[key: string]: string}
    Key-value map of the org's tags.
    observability OrgObservabilityArgs
    The retention period (in days) for logs, metrics, and traces. Charges apply for storage beyond the 30 day default.
    account_id str
    The associated account ID that will be used when creating the org. Only used on org creation. The account ID can be obtained from the Org Management & Billing page.
    auth_config OrgAuthConfigArgs
    The configuration settings and parameters related to authentication within the org.
    description str
    The description of org.
    invitees Sequence[str]
    When an org is created, the list of email addresses which will receive an invitation to join the org and be assigned to the superusers group. The user account used when creating the org will be included in this list.
    security OrgSecurityArgs
    session_timeout_seconds int
    The idle time (in seconds) in which the console UI will automatically sign-out the user. Default: 900 (15 minutes)
    tags Mapping[str, str]
    Key-value map of the org's tags.
    observability Property Map
    The retention period (in days) for logs, metrics, and traces. Charges apply for storage beyond the 30 day default.
    accountId String
    The associated account ID that will be used when creating the org. Only used on org creation. The account ID can be obtained from the Org Management & Billing page.
    authConfig Property Map
    The configuration settings and parameters related to authentication within the org.
    description String
    The description of org.
    invitees List<String>
    When an org is created, the list of email addresses which will receive an invitation to join the org and be assigned to the superusers group. The user account used when creating the org will be included in this list.
    security Property Map
    sessionTimeoutSeconds Number
    The idle time (in seconds) in which the console UI will automatically sign-out the user. Default: 900 (15 minutes)
    tags Map<String>
    Key-value map of the org's tags.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Org resource produces the following output properties:

    CplnId string
    The ID, in GUID format, of the org.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the org.
    SelfLink string
    Full link to this resource. Can be referenced by other resources.
    Statuses List<Pulumiverse.Cpln.Outputs.OrgStatus>
    Status of the org.
    CplnId string
    The ID, in GUID format, of the org.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the org.
    SelfLink string
    Full link to this resource. Can be referenced by other resources.
    Statuses []OrgStatus
    Status of the org.
    cplnId String
    The ID, in GUID format, of the org.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the org.
    selfLink String
    Full link to this resource. Can be referenced by other resources.
    statuses List<OrgStatus>
    Status of the org.
    cplnId string
    The ID, in GUID format, of the org.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the org.
    selfLink string
    Full link to this resource. Can be referenced by other resources.
    statuses OrgStatus[]
    Status of the org.
    cpln_id str
    The ID, in GUID format, of the org.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the org.
    self_link str
    Full link to this resource. Can be referenced by other resources.
    statuses Sequence[OrgStatus]
    Status of the org.
    cplnId String
    The ID, in GUID format, of the org.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the org.
    selfLink String
    Full link to this resource. Can be referenced by other resources.
    statuses List<Property Map>
    Status of the org.

    Look up Existing Org Resource

    Get an existing Org 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?: OrgState, opts?: CustomResourceOptions): Org
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        auth_config: Optional[OrgAuthConfigArgs] = None,
        cpln_id: Optional[str] = None,
        description: Optional[str] = None,
        invitees: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        observability: Optional[OrgObservabilityArgs] = None,
        security: Optional[OrgSecurityArgs] = None,
        self_link: Optional[str] = None,
        session_timeout_seconds: Optional[int] = None,
        statuses: Optional[Sequence[OrgStatusArgs]] = None,
        tags: Optional[Mapping[str, str]] = None) -> Org
    func GetOrg(ctx *Context, name string, id IDInput, state *OrgState, opts ...ResourceOption) (*Org, error)
    public static Org Get(string name, Input<string> id, OrgState? state, CustomResourceOptions? opts = null)
    public static Org get(String name, Output<String> id, OrgState 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:
    AccountId string
    The associated account ID that will be used when creating the org. Only used on org creation. The account ID can be obtained from the Org Management & Billing page.
    AuthConfig Pulumiverse.Cpln.Inputs.OrgAuthConfig
    The configuration settings and parameters related to authentication within the org.
    CplnId string
    The ID, in GUID format, of the org.
    Description string
    The description of org.
    Invitees List<string>
    When an org is created, the list of email addresses which will receive an invitation to join the org and be assigned to the superusers group. The user account used when creating the org will be included in this list.
    Name string
    The name of the org.
    Observability Pulumiverse.Cpln.Inputs.OrgObservability
    The retention period (in days) for logs, metrics, and traces. Charges apply for storage beyond the 30 day default.
    Security Pulumiverse.Cpln.Inputs.OrgSecurity
    SelfLink string
    Full link to this resource. Can be referenced by other resources.
    SessionTimeoutSeconds int
    The idle time (in seconds) in which the console UI will automatically sign-out the user. Default: 900 (15 minutes)
    Statuses List<Pulumiverse.Cpln.Inputs.OrgStatus>
    Status of the org.
    Tags Dictionary<string, string>
    Key-value map of the org's tags.
    AccountId string
    The associated account ID that will be used when creating the org. Only used on org creation. The account ID can be obtained from the Org Management & Billing page.
    AuthConfig OrgAuthConfigArgs
    The configuration settings and parameters related to authentication within the org.
    CplnId string
    The ID, in GUID format, of the org.
    Description string
    The description of org.
    Invitees []string
    When an org is created, the list of email addresses which will receive an invitation to join the org and be assigned to the superusers group. The user account used when creating the org will be included in this list.
    Name string
    The name of the org.
    Observability OrgObservabilityArgs
    The retention period (in days) for logs, metrics, and traces. Charges apply for storage beyond the 30 day default.
    Security OrgSecurityArgs
    SelfLink string
    Full link to this resource. Can be referenced by other resources.
    SessionTimeoutSeconds int
    The idle time (in seconds) in which the console UI will automatically sign-out the user. Default: 900 (15 minutes)
    Statuses []OrgStatusArgs
    Status of the org.
    Tags map[string]string
    Key-value map of the org's tags.
    accountId String
    The associated account ID that will be used when creating the org. Only used on org creation. The account ID can be obtained from the Org Management & Billing page.
    authConfig OrgAuthConfig
    The configuration settings and parameters related to authentication within the org.
    cplnId String
    The ID, in GUID format, of the org.
    description String
    The description of org.
    invitees List<String>
    When an org is created, the list of email addresses which will receive an invitation to join the org and be assigned to the superusers group. The user account used when creating the org will be included in this list.
    name String
    The name of the org.
    observability OrgObservability
    The retention period (in days) for logs, metrics, and traces. Charges apply for storage beyond the 30 day default.
    security OrgSecurity
    selfLink String
    Full link to this resource. Can be referenced by other resources.
    sessionTimeoutSeconds Integer
    The idle time (in seconds) in which the console UI will automatically sign-out the user. Default: 900 (15 minutes)
    statuses List<OrgStatus>
    Status of the org.
    tags Map<String,String>
    Key-value map of the org's tags.
    accountId string
    The associated account ID that will be used when creating the org. Only used on org creation. The account ID can be obtained from the Org Management & Billing page.
    authConfig OrgAuthConfig
    The configuration settings and parameters related to authentication within the org.
    cplnId string
    The ID, in GUID format, of the org.
    description string
    The description of org.
    invitees string[]
    When an org is created, the list of email addresses which will receive an invitation to join the org and be assigned to the superusers group. The user account used when creating the org will be included in this list.
    name string
    The name of the org.
    observability OrgObservability
    The retention period (in days) for logs, metrics, and traces. Charges apply for storage beyond the 30 day default.
    security OrgSecurity
    selfLink string
    Full link to this resource. Can be referenced by other resources.
    sessionTimeoutSeconds number
    The idle time (in seconds) in which the console UI will automatically sign-out the user. Default: 900 (15 minutes)
    statuses OrgStatus[]
    Status of the org.
    tags {[key: string]: string}
    Key-value map of the org's tags.
    account_id str
    The associated account ID that will be used when creating the org. Only used on org creation. The account ID can be obtained from the Org Management & Billing page.
    auth_config OrgAuthConfigArgs
    The configuration settings and parameters related to authentication within the org.
    cpln_id str
    The ID, in GUID format, of the org.
    description str
    The description of org.
    invitees Sequence[str]
    When an org is created, the list of email addresses which will receive an invitation to join the org and be assigned to the superusers group. The user account used when creating the org will be included in this list.
    name str
    The name of the org.
    observability OrgObservabilityArgs
    The retention period (in days) for logs, metrics, and traces. Charges apply for storage beyond the 30 day default.
    security OrgSecurityArgs
    self_link str
    Full link to this resource. Can be referenced by other resources.
    session_timeout_seconds int
    The idle time (in seconds) in which the console UI will automatically sign-out the user. Default: 900 (15 minutes)
    statuses Sequence[OrgStatusArgs]
    Status of the org.
    tags Mapping[str, str]
    Key-value map of the org's tags.
    accountId String
    The associated account ID that will be used when creating the org. Only used on org creation. The account ID can be obtained from the Org Management & Billing page.
    authConfig Property Map
    The configuration settings and parameters related to authentication within the org.
    cplnId String
    The ID, in GUID format, of the org.
    description String
    The description of org.
    invitees List<String>
    When an org is created, the list of email addresses which will receive an invitation to join the org and be assigned to the superusers group. The user account used when creating the org will be included in this list.
    name String
    The name of the org.
    observability Property Map
    The retention period (in days) for logs, metrics, and traces. Charges apply for storage beyond the 30 day default.
    security Property Map
    selfLink String
    Full link to this resource. Can be referenced by other resources.
    sessionTimeoutSeconds Number
    The idle time (in seconds) in which the console UI will automatically sign-out the user. Default: 900 (15 minutes)
    statuses List<Property Map>
    Status of the org.
    tags Map<String>
    Key-value map of the org's tags.

    Supporting Types

    OrgAuthConfig, OrgAuthConfigArgs

    DomainAutoMembers List<string>
    SamlOnly bool
    domainAutoMembers List<String>
    samlOnly Boolean
    domainAutoMembers string[]
    samlOnly boolean
    domain_auto_members Sequence[str]
    saml_only bool
    domainAutoMembers List<String>
    samlOnly Boolean

    OrgObservability, OrgObservabilityArgs

    OrgSecurity, OrgSecurityArgs

    OrgSecurityThreatDetection, OrgSecurityThreatDetectionArgs

    OrgSecurityThreatDetectionSyslog, OrgSecurityThreatDetectionSyslogArgs

    Port int
    Host string
    Transport string
    Port int
    Host string
    Transport string
    port Integer
    host String
    transport String
    port number
    host string
    transport string
    port int
    host str
    transport str
    port Number
    host String
    transport String

    OrgStatus, OrgStatusArgs

    AccountLink string
    Active bool
    AccountLink string
    Active bool
    accountLink String
    active Boolean
    accountLink string
    active boolean
    accountLink String
    active Boolean

    Package Details

    Repository
    cpln pulumiverse/pulumi-cpln
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cpln Terraform Provider.
    cpln logo
    Control Plane v0.0.27 published on Saturday, May 25, 2024 by pulumiverse
    pulumiverse/pulumi-cpln