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

cpln.Group

Explore with Pulumi AI

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

    Create Group Resource

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

    Constructor syntax

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

@overload
def Group(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          description: Optional[str] = None,
          identity_matcher: Optional[GroupIdentityMatcherArgs] = None,
          member_query: Optional[GroupMemberQueryArgs] = None,
          name: Optional[str] = None,
          service_accounts: Optional[Sequence[str]] = None,
          tags: Optional[Mapping[str, str]] = None,
          user_ids_and_emails: Optional[Sequence[str]] = None)
    func NewGroup(ctx *Context, name string, args *GroupArgs, opts ...ResourceOption) (*Group, error)
    public Group(string name, GroupArgs? args = null, CustomResourceOptions? opts = null)
    public Group(String name, GroupArgs args)
public Group(String name, GroupArgs args, CustomResourceOptions options)

    type: cpln:Group
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 GroupArgs
    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 GroupArgs
    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 GroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GroupArgs
    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 groupResource = new Cpln.Group("groupResource", new()
{
    Description = "string",
    IdentityMatcher = new Cpln.Inputs.GroupIdentityMatcherArgs
    {
        Expression = "string",
        Language = "string",
    },
    MemberQuery = new Cpln.Inputs.GroupMemberQueryArgs
    {
        Fetch = "string",
        Spec = new Cpln.Inputs.GroupMemberQuerySpecArgs
        {
            Match = "string",
            Terms = new[]
            {
                new Cpln.Inputs.GroupMemberQuerySpecTermArgs
                {
                    Op = "string",
                    Property = "string",
                    Tag = "string",
                    Value = "string",
                },
            },
        },
    },
    Name = "string",
    ServiceAccounts = new[]
    {
        "string",
    },
    Tags = 
    {
        { "string", "string" },
    },
    UserIdsAndEmails = new[]
    {
        "string",
    },
});

    example, err := cpln.NewGroup(ctx, "groupResource", &cpln.GroupArgs{
	Description: pulumi.String("string"),
	IdentityMatcher: &cpln.GroupIdentityMatcherArgs{
		Expression: pulumi.String("string"),
		Language:   pulumi.String("string"),
	},
	MemberQuery: &cpln.GroupMemberQueryArgs{
		Fetch: pulumi.String("string"),
		Spec: &cpln.GroupMemberQuerySpecArgs{
			Match: pulumi.String("string"),
			Terms: cpln.GroupMemberQuerySpecTermArray{
				&cpln.GroupMemberQuerySpecTermArgs{
					Op:       pulumi.String("string"),
					Property: pulumi.String("string"),
					Tag:      pulumi.String("string"),
					Value:    pulumi.String("string"),
				},
			},
		},
	},
	Name: pulumi.String("string"),
	ServiceAccounts: pulumi.StringArray{
		pulumi.String("string"),
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	UserIdsAndEmails: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var groupResource = new Group("groupResource", GroupArgs.builder()
    .description("string")
    .identityMatcher(GroupIdentityMatcherArgs.builder()
        .expression("string")
        .language("string")
        .build())
    .memberQuery(GroupMemberQueryArgs.builder()
        .fetch("string")
        .spec(GroupMemberQuerySpecArgs.builder()
            .match("string")
            .terms(GroupMemberQuerySpecTermArgs.builder()
                .op("string")
                .property("string")
                .tag("string")
                .value("string")
                .build())
            .build())
        .build())
    .name("string")
    .serviceAccounts("string")
    .tags(Map.of("string", "string"))
    .userIdsAndEmails("string")
    .build());

    group_resource = cpln.Group("groupResource",
    description="string",
    identity_matcher=cpln.GroupIdentityMatcherArgs(
        expression="string",
        language="string",
    ),
    member_query=cpln.GroupMemberQueryArgs(
        fetch="string",
        spec=cpln.GroupMemberQuerySpecArgs(
            match="string",
            terms=[cpln.GroupMemberQuerySpecTermArgs(
                op="string",
                property="string",
                tag="string",
                value="string",
            )],
        ),
    ),
    name="string",
    service_accounts=["string"],
    tags={
        "string": "string",
    },
    user_ids_and_emails=["string"])

    const groupResource = new cpln.Group("groupResource", {
    description: "string",
    identityMatcher: {
        expression: "string",
        language: "string",
    },
    memberQuery: {
        fetch: "string",
        spec: {
            match: "string",
            terms: [{
                op: "string",
                property: "string",
                tag: "string",
                value: "string",
            }],
        },
    },
    name: "string",
    serviceAccounts: ["string"],
    tags: {
        string: "string",
    },
    userIdsAndEmails: ["string"],
});

    type: cpln:Group
properties:
    description: string
    identityMatcher:
        expression: string
        language: string
    memberQuery:
        fetch: string
        spec:
            match: string
            terms:
                - op: string
                  property: string
                  tag: string
                  value: string
    name: string
    serviceAccounts:
        - string
    tags:
        string: string
    userIdsAndEmails:
        - string

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

    Description string
    Description of Group.
    IdentityMatcher Pulumiverse.Cpln.Inputs.GroupIdentityMatcher
    Executes the expression against the users' claims to decide whether a user belongs to this group. This method is useful for managing the grouping of users logged-in with SAML providers.
    MemberQuery Pulumiverse.Cpln.Inputs.GroupMemberQuery
    A predefined set of criteria or conditions used to query and retrieve members within the group.
    Name string
    Name of the Group.
    ServiceAccounts List<string>
    List of service accounts that exists within the configured org. Group membership will fail if the service account does not exits within the org.
    Tags Dictionary<string, string>
    Key-value map of resource tags.
    UserIdsAndEmails List<string>
    List of either the user ID or email address for a user that exists within the configured org. Group membership will fail if the user ID / email does not exist within the org.
    Description string
    Description of Group.
    IdentityMatcher GroupIdentityMatcherArgs
    Executes the expression against the users' claims to decide whether a user belongs to this group. This method is useful for managing the grouping of users logged-in with SAML providers.
    MemberQuery GroupMemberQueryArgs
    A predefined set of criteria or conditions used to query and retrieve members within the group.
    Name string
    Name of the Group.
    ServiceAccounts []string
    List of service accounts that exists within the configured org. Group membership will fail if the service account does not exits within the org.
    Tags map[string]string
    Key-value map of resource tags.
    UserIdsAndEmails []string
    List of either the user ID or email address for a user that exists within the configured org. Group membership will fail if the user ID / email does not exist within the org.
    description String
    Description of Group.
    identityMatcher GroupIdentityMatcher
    Executes the expression against the users' claims to decide whether a user belongs to this group. This method is useful for managing the grouping of users logged-in with SAML providers.
    memberQuery GroupMemberQuery
    A predefined set of criteria or conditions used to query and retrieve members within the group.
    name String
    Name of the Group.
    serviceAccounts List<String>
    List of service accounts that exists within the configured org. Group membership will fail if the service account does not exits within the org.
    tags Map<String,String>
    Key-value map of resource tags.
    userIdsAndEmails List<String>
    List of either the user ID or email address for a user that exists within the configured org. Group membership will fail if the user ID / email does not exist within the org.
    description string
    Description of Group.
    identityMatcher GroupIdentityMatcher
    Executes the expression against the users' claims to decide whether a user belongs to this group. This method is useful for managing the grouping of users logged-in with SAML providers.
    memberQuery GroupMemberQuery
    A predefined set of criteria or conditions used to query and retrieve members within the group.
    name string
    Name of the Group.
    serviceAccounts string[]
    List of service accounts that exists within the configured org. Group membership will fail if the service account does not exits within the org.
    tags {[key: string]: string}
    Key-value map of resource tags.
    userIdsAndEmails string[]
    List of either the user ID or email address for a user that exists within the configured org. Group membership will fail if the user ID / email does not exist within the org.
    description str
    Description of Group.
    identity_matcher GroupIdentityMatcherArgs
    Executes the expression against the users' claims to decide whether a user belongs to this group. This method is useful for managing the grouping of users logged-in with SAML providers.
    member_query GroupMemberQueryArgs
    A predefined set of criteria or conditions used to query and retrieve members within the group.
    name str
    Name of the Group.
    service_accounts Sequence[str]
    List of service accounts that exists within the configured org. Group membership will fail if the service account does not exits within the org.
    tags Mapping[str, str]
    Key-value map of resource tags.
    user_ids_and_emails Sequence[str]
    List of either the user ID or email address for a user that exists within the configured org. Group membership will fail if the user ID / email does not exist within the org.
    description String
    Description of Group.
    identityMatcher Property Map
    Executes the expression against the users' claims to decide whether a user belongs to this group. This method is useful for managing the grouping of users logged-in with SAML providers.
    memberQuery Property Map
    A predefined set of criteria or conditions used to query and retrieve members within the group.
    name String
    Name of the Group.
    serviceAccounts List<String>
    List of service accounts that exists within the configured org. Group membership will fail if the service account does not exits within the org.
    tags Map<String>
    Key-value map of resource tags.
    userIdsAndEmails List<String>
    List of either the user ID or email address for a user that exists within the configured org. Group membership will fail if the user ID / email does not exist within the org.

    Outputs

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

    CplnId string
    The ID, in GUID format, of the Group.
    Id string
    The provider-assigned unique ID for this managed resource.
    Origin string
    Origin of the service account. Either builtin or default.
    SelfLink string
    Fully qualified link to the this group.
    CplnId string
    The ID, in GUID format, of the Group.
    Id string
    The provider-assigned unique ID for this managed resource.
    Origin string
    Origin of the service account. Either builtin or default.
    SelfLink string
    Fully qualified link to the this group.
    cplnId String
    The ID, in GUID format, of the Group.
    id String
    The provider-assigned unique ID for this managed resource.
    origin String
    Origin of the service account. Either builtin or default.
    selfLink String
    Fully qualified link to the this group.
    cplnId string
    The ID, in GUID format, of the Group.
    id string
    The provider-assigned unique ID for this managed resource.
    origin string
    Origin of the service account. Either builtin or default.
    selfLink string
    Fully qualified link to the this group.
    cpln_id str
    The ID, in GUID format, of the Group.
    id str
    The provider-assigned unique ID for this managed resource.
    origin str
    Origin of the service account. Either builtin or default.
    self_link str
    Fully qualified link to the this group.
    cplnId String
    The ID, in GUID format, of the Group.
    id String
    The provider-assigned unique ID for this managed resource.
    origin String
    Origin of the service account. Either builtin or default.
    selfLink String
    Fully qualified link to the this group.

    Look up Existing Group Resource

    Get an existing Group 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?: GroupState, opts?: CustomResourceOptions): Group
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cpln_id: Optional[str] = None,
        description: Optional[str] = None,
        identity_matcher: Optional[GroupIdentityMatcherArgs] = None,
        member_query: Optional[GroupMemberQueryArgs] = None,
        name: Optional[str] = None,
        origin: Optional[str] = None,
        self_link: Optional[str] = None,
        service_accounts: Optional[Sequence[str]] = None,
        tags: Optional[Mapping[str, str]] = None,
        user_ids_and_emails: Optional[Sequence[str]] = None) -> Group
    func GetGroup(ctx *Context, name string, id IDInput, state *GroupState, opts ...ResourceOption) (*Group, error)
    public static Group Get(string name, Input<string> id, GroupState? state, CustomResourceOptions? opts = null)
    public static Group get(String name, Output<String> id, GroupState 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:
    CplnId string
    The ID, in GUID format, of the Group.
    Description string
    Description of Group.
    IdentityMatcher Pulumiverse.Cpln.Inputs.GroupIdentityMatcher
    Executes the expression against the users' claims to decide whether a user belongs to this group. This method is useful for managing the grouping of users logged-in with SAML providers.
    MemberQuery Pulumiverse.Cpln.Inputs.GroupMemberQuery
    A predefined set of criteria or conditions used to query and retrieve members within the group.
    Name string
    Name of the Group.
    Origin string
    Origin of the service account. Either builtin or default.
    SelfLink string
    Fully qualified link to the this group.
    ServiceAccounts List<string>
    List of service accounts that exists within the configured org. Group membership will fail if the service account does not exits within the org.
    Tags Dictionary<string, string>
    Key-value map of resource tags.
    UserIdsAndEmails List<string>
    List of either the user ID or email address for a user that exists within the configured org. Group membership will fail if the user ID / email does not exist within the org.
    CplnId string
    The ID, in GUID format, of the Group.
    Description string
    Description of Group.
    IdentityMatcher GroupIdentityMatcherArgs
    Executes the expression against the users' claims to decide whether a user belongs to this group. This method is useful for managing the grouping of users logged-in with SAML providers.
    MemberQuery GroupMemberQueryArgs
    A predefined set of criteria or conditions used to query and retrieve members within the group.
    Name string
    Name of the Group.
    Origin string
    Origin of the service account. Either builtin or default.
    SelfLink string
    Fully qualified link to the this group.
    ServiceAccounts []string
    List of service accounts that exists within the configured org. Group membership will fail if the service account does not exits within the org.
    Tags map[string]string
    Key-value map of resource tags.
    UserIdsAndEmails []string
    List of either the user ID or email address for a user that exists within the configured org. Group membership will fail if the user ID / email does not exist within the org.
    cplnId String
    The ID, in GUID format, of the Group.
    description String
    Description of Group.
    identityMatcher GroupIdentityMatcher
    Executes the expression against the users' claims to decide whether a user belongs to this group. This method is useful for managing the grouping of users logged-in with SAML providers.
    memberQuery GroupMemberQuery
    A predefined set of criteria or conditions used to query and retrieve members within the group.
    name String
    Name of the Group.
    origin String
    Origin of the service account. Either builtin or default.
    selfLink String
    Fully qualified link to the this group.
    serviceAccounts List<String>
    List of service accounts that exists within the configured org. Group membership will fail if the service account does not exits within the org.
    tags Map<String,String>
    Key-value map of resource tags.
    userIdsAndEmails List<String>
    List of either the user ID or email address for a user that exists within the configured org. Group membership will fail if the user ID / email does not exist within the org.
    cplnId string
    The ID, in GUID format, of the Group.
    description string
    Description of Group.
    identityMatcher GroupIdentityMatcher
    Executes the expression against the users' claims to decide whether a user belongs to this group. This method is useful for managing the grouping of users logged-in with SAML providers.
    memberQuery GroupMemberQuery
    A predefined set of criteria or conditions used to query and retrieve members within the group.
    name string
    Name of the Group.
    origin string
    Origin of the service account. Either builtin or default.
    selfLink string
    Fully qualified link to the this group.
    serviceAccounts string[]
    List of service accounts that exists within the configured org. Group membership will fail if the service account does not exits within the org.
    tags {[key: string]: string}
    Key-value map of resource tags.
    userIdsAndEmails string[]
    List of either the user ID or email address for a user that exists within the configured org. Group membership will fail if the user ID / email does not exist within the org.
    cpln_id str
    The ID, in GUID format, of the Group.
    description str
    Description of Group.
    identity_matcher GroupIdentityMatcherArgs
    Executes the expression against the users' claims to decide whether a user belongs to this group. This method is useful for managing the grouping of users logged-in with SAML providers.
    member_query GroupMemberQueryArgs
    A predefined set of criteria or conditions used to query and retrieve members within the group.
    name str
    Name of the Group.
    origin str
    Origin of the service account. Either builtin or default.
    self_link str
    Fully qualified link to the this group.
    service_accounts Sequence[str]
    List of service accounts that exists within the configured org. Group membership will fail if the service account does not exits within the org.
    tags Mapping[str, str]
    Key-value map of resource tags.
    user_ids_and_emails Sequence[str]
    List of either the user ID or email address for a user that exists within the configured org. Group membership will fail if the user ID / email does not exist within the org.
    cplnId String
    The ID, in GUID format, of the Group.
    description String
    Description of Group.
    identityMatcher Property Map
    Executes the expression against the users' claims to decide whether a user belongs to this group. This method is useful for managing the grouping of users logged-in with SAML providers.
    memberQuery Property Map
    A predefined set of criteria or conditions used to query and retrieve members within the group.
    name String
    Name of the Group.
    origin String
    Origin of the service account. Either builtin or default.
    selfLink String
    Fully qualified link to the this group.
    serviceAccounts List<String>
    List of service accounts that exists within the configured org. Group membership will fail if the service account does not exits within the org.
    tags Map<String>
    Key-value map of resource tags.
    userIdsAndEmails List<String>
    List of either the user ID or email address for a user that exists within the configured org. Group membership will fail if the user ID / email does not exist within the org.

    Supporting Types

    GroupIdentityMatcher, GroupIdentityMatcherArgs

    Expression string
    Language string
    Expression string
    Language string
    expression String
    language String
    expression string
    language string
    expression String
    language String

    GroupMemberQuery, GroupMemberQueryArgs

    GroupMemberQuerySpec, GroupMemberQuerySpecArgs

    GroupMemberQuerySpecTerm, GroupMemberQuerySpecTermArgs

    Op string
    Property string
    Tag string
    Value string
    Op string
    Property string
    Tag string
    Value string
    op String
    property String
    tag String
    value String
    op string
    property string
    tag string
    value string
    op str
    property str
    tag str
    value str
    op String
    property String
    tag String
    value String

    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