Docs
PackagesAWS Native is in preview. AWS Classic is fully supported.
AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi
aws-native.cognito.UserPoolGroup
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi
Resource Type definition for AWS::Cognito::UserPoolGroup
Create UserPoolGroup Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new UserPoolGroup(name: string, args: UserPoolGroupArgs, opts?: CustomResourceOptions);@overload
def UserPoolGroup(resource_name: str,
args: UserPoolGroupArgs,
opts: Optional[ResourceOptions] = None)
@overload
def UserPoolGroup(resource_name: str,
opts: Optional[ResourceOptions] = None,
user_pool_id: Optional[str] = None,
description: Optional[str] = None,
group_name: Optional[str] = None,
precedence: Optional[int] = None,
role_arn: Optional[str] = None)func NewUserPoolGroup(ctx *Context, name string, args UserPoolGroupArgs, opts ...ResourceOption) (*UserPoolGroup, error)public UserPoolGroup(string name, UserPoolGroupArgs args, CustomResourceOptions? opts = null)
public UserPoolGroup(String name, UserPoolGroupArgs args)
public UserPoolGroup(String name, UserPoolGroupArgs args, CustomResourceOptions options)
type: aws-native:cognito:UserPoolGroup
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 UserPoolGroupArgs
- 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 UserPoolGroupArgs
- 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 UserPoolGroupArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args UserPoolGroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args UserPoolGroupArgs
- 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.
Coming soon!
Coming soon!
Coming soon!
Coming soon!
const userPoolGroupResource = new aws_native.cognito.UserPoolGroup("userPoolGroupResource", {
userPoolId: "string",
description: "string",
groupName: "string",
precedence: 0,
roleArn: "string",
});
Coming soon!
UserPoolGroup 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 UserPoolGroup resource accepts the following input properties:
- User
Pool stringId - Description string
- Group
Name string - Precedence int
- Role
Arn string
- User
Pool stringId - Description string
- Group
Name string - Precedence int
- Role
Arn string
- user
Pool StringId - description String
- group
Name String - precedence Integer
- role
Arn String
- user
Pool stringId - description string
- group
Name string - precedence number
- role
Arn string
- user_
pool_ strid - description str
- group_
name str - precedence int
- role_
arn str
- user
Pool StringId - description String
- group
Name String - precedence Number
- role
Arn String
Outputs
All input properties are implicitly available as output properties. Additionally, the UserPoolGroup 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.
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.
AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi