We recommend new projects start with resources from the AWS provider.
aws-native.cognito.Terms
We recommend new projects start with resources from the AWS provider.
Resource Type definition for AWS::Cognito::Terms
Create Terms Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Terms(name: string, args: TermsArgs, opts?: CustomResourceOptions);@overload
def Terms(resource_name: str,
args: TermsArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Terms(resource_name: str,
opts: Optional[ResourceOptions] = None,
enforcement: Optional[TermsEnforcementType] = None,
links: Optional[Mapping[str, str]] = None,
terms_source: Optional[TermsSourceType] = None,
user_pool_id: Optional[str] = None,
client_id: Optional[str] = None,
terms_name: Optional[str] = None)func NewTerms(ctx *Context, name string, args TermsArgs, opts ...ResourceOption) (*Terms, error)public Terms(string name, TermsArgs args, CustomResourceOptions? opts = null)type: aws-native:cognito:Terms
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 TermsArgs
- 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 TermsArgs
- 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 TermsArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args TermsArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args TermsArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Terms Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Terms resource accepts the following input properties:
- Enforcement
Pulumi.
Aws Native. Cognito. Terms Enforcement Type - Links Dictionary<string, string>
- Terms
Source Pulumi.Aws Native. Cognito. Terms Source Type - User
Pool stringId - Client
Id string - Terms
Name string
- Enforcement
Terms
Enforcement Type - Links map[string]string
- Terms
Source TermsSource Type - User
Pool stringId - Client
Id string - Terms
Name string
- enforcement
Terms
Enforcement Type - links Map<String,String>
- terms
Source TermsSource Type - user
Pool StringId - client
Id String - terms
Name String
- enforcement
Terms
Enforcement Type - links {[key: string]: string}
- terms
Source TermsSource Type - user
Pool stringId - client
Id string - terms
Name string
- enforcement
Terms
Enforcement Type - links Mapping[str, str]
- terms_
source TermsSource Type - user_
pool_ strid - client_
id str - terms_
name str
- enforcement "NONE"
- links Map<String>
- terms
Source "LINK" - user
Pool StringId - client
Id String - terms
Name String
Outputs
All input properties are implicitly available as output properties. Additionally, the Terms resource produces the following output properties:
Supporting Types
TermsEnforcementType, TermsEnforcementTypeArgs
- None
- NONE
- Terms
Enforcement Type None - NONE
- None
- NONE
- None
- NONE
- NONE
- NONE
- "NONE"
- NONE
TermsSourceType, TermsSourceTypeArgs
- Link
- LINK
- Terms
Source Type Link - LINK
- Link
- LINK
- Link
- LINK
- LINK
- LINK
- "LINK"
- LINK
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
