@pulumiverse/cpln
Version:
A Pulumi package for creating and managing Control Plane (cpln) resources.
162 lines (161 loc) • 6.16 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
export declare class Group extends pulumi.CustomResource {
/**
* Get an existing Group resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: GroupState, opts?: pulumi.CustomResourceOptions): Group;
/**
* Returns true if the given object is an instance of Group. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Group;
/**
* The ID, in GUID format, of the Group.
*/
readonly cplnId: pulumi.Output<string>;
/**
* Description of the Group.
*/
readonly description: pulumi.Output<string>;
/**
* 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.
*/
readonly identityMatcher: pulumi.Output<outputs.GroupIdentityMatcher | undefined>;
/**
* A predefined set of criteria or conditions used to query and retrieve members within the group.
*/
readonly memberQuery: pulumi.Output<outputs.GroupMemberQuery | undefined>;
/**
* Name of the Group.
*/
readonly name: pulumi.Output<string>;
/**
* Origin of the service account. Either `builtin` or `default`.
*/
readonly origin: pulumi.Output<string>;
/**
* Full link to this resource. Can be referenced by other resources.
*/
readonly selfLink: pulumi.Output<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.
*/
readonly serviceAccounts: pulumi.Output<string[] | undefined>;
/**
* Key-value map of resource tags.
*/
readonly tags: pulumi.Output<{
[key: string]: 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.
*/
readonly userIdsAndEmails: pulumi.Output<string[] | undefined>;
/**
* Create a Group resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args?: GroupArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Group resources.
*/
export interface GroupState {
/**
* The ID, in GUID format, of the Group.
*/
cplnId?: pulumi.Input<string>;
/**
* Description of the Group.
*/
description?: pulumi.Input<string>;
/**
* 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.
*/
identityMatcher?: pulumi.Input<inputs.GroupIdentityMatcher>;
/**
* A predefined set of criteria or conditions used to query and retrieve members within the group.
*/
memberQuery?: pulumi.Input<inputs.GroupMemberQuery>;
/**
* Name of the Group.
*/
name?: pulumi.Input<string>;
/**
* Origin of the service account. Either `builtin` or `default`.
*/
origin?: pulumi.Input<string>;
/**
* Full link to this resource. Can be referenced by other resources.
*/
selfLink?: pulumi.Input<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.
*/
serviceAccounts?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Key-value map of resource tags.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<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.
*/
userIdsAndEmails?: pulumi.Input<pulumi.Input<string>[]>;
}
/**
* The set of arguments for constructing a Group resource.
*/
export interface GroupArgs {
/**
* Description of the Group.
*/
description?: pulumi.Input<string>;
/**
* 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.
*/
identityMatcher?: pulumi.Input<inputs.GroupIdentityMatcher>;
/**
* A predefined set of criteria or conditions used to query and retrieve members within the group.
*/
memberQuery?: pulumi.Input<inputs.GroupMemberQuery>;
/**
* Name of the Group.
*/
name?: pulumi.Input<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.
*/
serviceAccounts?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Key-value map of resource tags.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<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.
*/
userIdsAndEmails?: pulumi.Input<pulumi.Input<string>[]>;
}