Skip to content

Latest commit

 

History

History
1646 lines (1024 loc) · 76.6 KB

cognitoIdentityPool.md

File metadata and controls

1646 lines (1024 loc) · 76.6 KB

aws_cognito_identity_pool

Refer to the Terraform Registory for docs: aws_cognito_identity_pool.

cognitoIdentityPool Submodule

Constructs

CognitoIdentityPool

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_identity_pool aws_cognito_identity_pool}.

Initializers 

import { cognitoIdentityPool } from '@cdktf/aws-cdk'

new cognitoIdentityPool.CognitoIdentityPool(scope: Construct, id: string, config: CognitoIdentityPoolConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config CognitoIdentityPoolConfig No description.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

configRequired

Methods

Name Description
toString Returns a string representation of this construct.
addOverride No description.
overrideLogicalId Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
putCognitoIdentityProviders No description.
resetAllowClassicFlow No description.
resetAllowUnauthenticatedIdentities No description.
resetCognitoIdentityProviders No description.
resetDeveloperProviderName No description.
resetId No description.
resetOpenidConnectProviderArns No description.
resetSamlProviderArns No description.
resetSupportedLoginProviders No description.
resetTags No description.
resetTagsAll No description.
toString 
public toString(): string

Returns a string representation of this construct.

addOverride 
public addOverride(path: string, value: any): void
pathRequired
  • Type: string
valueRequired
  • Type: any
overrideLogicalId 
public overrideLogicalId(newLogicalId: string): void

Overrides the auto-generated logical ID with a specific ID.

newLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public resetOverrideLogicalId(): void

Resets a previously passed logical Id to use the auto-generated logical id again.

toMetadata 
public toMetadata(): any
toTerraform 
public toTerraform(): any

Adds this resource to the terraform JSON output.

getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
interpolationForAttribute 
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
putCognitoIdentityProviders 
public putCognitoIdentityProviders(value: IResolvable | CognitoIdentityPoolCognitoIdentityProviders[]): void
valueRequired
resetAllowClassicFlow 
public resetAllowClassicFlow(): void
resetAllowUnauthenticatedIdentities 
public resetAllowUnauthenticatedIdentities(): void
resetCognitoIdentityProviders 
public resetCognitoIdentityProviders(): void
resetDeveloperProviderName 
public resetDeveloperProviderName(): void
resetId 
public resetId(): void
resetOpenidConnectProviderArns 
public resetOpenidConnectProviderArns(): void
resetSamlProviderArns 
public resetSamlProviderArns(): void
resetSupportedLoginProviders 
public resetSupportedLoginProviders(): void
resetTags 
public resetTags(): void
resetTagsAll 
public resetTagsAll(): void

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
isConstruct 
import { cognitoIdentityPool } from '@cdktf/aws-cdk'

cognitoIdentityPool.CognitoIdentityPool.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: any

Any object.

isTerraformElement 
import { cognitoIdentityPool } from '@cdktf/aws-cdk'

cognitoIdentityPool.CognitoIdentityPool.isTerraformElement(x: any)
xRequired
  • Type: any
isTerraformResource 
import { cognitoIdentityPool } from '@cdktf/aws-cdk'

cognitoIdentityPool.CognitoIdentityPool.isTerraformResource(x: any)
xRequired
  • Type: any

Properties

Name Type Description
node constructs.Node The tree node.
cdktfStack cdktf.TerraformStack No description.
fqn string No description.
friendlyUniqueId string No description.
terraformMetaArguments {[ key: string ]: any} No description.
terraformResourceType string No description.
terraformGeneratorMetadata cdktf.TerraformProviderGeneratorMetadata No description.
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn string[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
arn string No description.
cognitoIdentityProviders CognitoIdentityPoolCognitoIdentityProvidersList No description.
allowClassicFlowInput boolean | cdktf.IResolvable No description.
allowUnauthenticatedIdentitiesInput boolean | cdktf.IResolvable No description.
cognitoIdentityProvidersInput cdktf.IResolvable | CognitoIdentityPoolCognitoIdentityProviders[] No description.
developerProviderNameInput string No description.
identityPoolNameInput string No description.
idInput string No description.
openidConnectProviderArnsInput string[] No description.
samlProviderArnsInput string[] No description.
supportedLoginProvidersInput {[ key: string ]: string} No description.
tagsAllInput {[ key: string ]: string} No description.
tagsInput {[ key: string ]: string} No description.
allowClassicFlow boolean | cdktf.IResolvable No description.
allowUnauthenticatedIdentities boolean | cdktf.IResolvable No description.
developerProviderName string No description.
id string No description.
identityPoolName string No description.
openidConnectProviderArns string[] No description.
samlProviderArns string[] No description.
supportedLoginProviders {[ key: string ]: string} No description.
tags {[ key: string ]: string} No description.
tagsAll {[ key: string ]: string} No description.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

cdktfStackRequired 
public readonly cdktfStack: TerraformStack;
  • Type: cdktf.TerraformStack
fqnRequired 
public readonly fqn: string;
  • Type: string
friendlyUniqueIdRequired 
public readonly friendlyUniqueId: string;
  • Type: string
terraformMetaArgumentsRequired 
public readonly terraformMetaArguments: {[ key: string ]: any};
  • Type: {[ key: string ]: any}
terraformResourceTypeRequired 
public readonly terraformResourceType: string;
  • Type: string
terraformGeneratorMetadataOptional 
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: string[];
  • Type: string[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
arnRequired 
public readonly arn: string;
  • Type: string
cognitoIdentityProvidersRequired 
public readonly cognitoIdentityProviders: CognitoIdentityPoolCognitoIdentityProvidersList;
allowClassicFlowInputOptional 
public readonly allowClassicFlowInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
allowUnauthenticatedIdentitiesInputOptional 
public readonly allowUnauthenticatedIdentitiesInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
cognitoIdentityProvidersInputOptional 
public readonly cognitoIdentityProvidersInput: IResolvable | CognitoIdentityPoolCognitoIdentityProviders[];
developerProviderNameInputOptional 
public readonly developerProviderNameInput: string;
  • Type: string
identityPoolNameInputOptional 
public readonly identityPoolNameInput: string;
  • Type: string
idInputOptional 
public readonly idInput: string;
  • Type: string
openidConnectProviderArnsInputOptional 
public readonly openidConnectProviderArnsInput: string[];
  • Type: string[]
samlProviderArnsInputOptional 
public readonly samlProviderArnsInput: string[];
  • Type: string[]
supportedLoginProvidersInputOptional 
public readonly supportedLoginProvidersInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
tagsAllInputOptional 
public readonly tagsAllInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
tagsInputOptional 
public readonly tagsInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
allowClassicFlowRequired 
public readonly allowClassicFlow: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
allowUnauthenticatedIdentitiesRequired 
public readonly allowUnauthenticatedIdentities: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
developerProviderNameRequired 
public readonly developerProviderName: string;
  • Type: string
idRequired 
public readonly id: string;
  • Type: string
identityPoolNameRequired 
public readonly identityPoolName: string;
  • Type: string
openidConnectProviderArnsRequired 
public readonly openidConnectProviderArns: string[];
  • Type: string[]
samlProviderArnsRequired 
public readonly samlProviderArns: string[];
  • Type: string[]
supportedLoginProvidersRequired 
public readonly supportedLoginProviders: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
tagsRequired 
public readonly tags: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
tagsAllRequired 
public readonly tagsAll: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Constants

Name Type Description
tfResourceType string No description.
tfResourceTypeRequired 
public readonly tfResourceType: string;
  • Type: string

Structs

CognitoIdentityPoolCognitoIdentityProviders

Initializer 

import { cognitoIdentityPool } from '@cdktf/aws-cdk'

const cognitoIdentityPoolCognitoIdentityProviders: cognitoIdentityPool.CognitoIdentityPoolCognitoIdentityProviders = { ... }

Properties

Name Type Description
clientId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_identity_pool#client_id CognitoIdentityPool#client_id}.
providerName string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_identity_pool#provider_name CognitoIdentityPool#provider_name}.
serverSideTokenCheck boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_identity_pool#server_side_token_check CognitoIdentityPool#server_side_token_check}.
clientIdOptional 
public readonly clientId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_identity_pool#client_id CognitoIdentityPool#client_id}.

providerNameOptional 
public readonly providerName: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_identity_pool#provider_name CognitoIdentityPool#provider_name}.

serverSideTokenCheckOptional 
public readonly serverSideTokenCheck: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_identity_pool#server_side_token_check CognitoIdentityPool#server_side_token_check}.

CognitoIdentityPoolConfig

Initializer 

import { cognitoIdentityPool } from '@cdktf/aws-cdk'

const cognitoIdentityPoolConfig: cognitoIdentityPool.CognitoIdentityPoolConfig = { ... }

Properties

Name Type Description
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn cdktf.ITerraformDependable[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
identityPoolName string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_identity_pool#identity_pool_name CognitoIdentityPool#identity_pool_name}.
allowClassicFlow boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_identity_pool#allow_classic_flow CognitoIdentityPool#allow_classic_flow}.
allowUnauthenticatedIdentities boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_identity_pool#allow_unauthenticated_identities CognitoIdentityPool#allow_unauthenticated_identities}.
cognitoIdentityProviders cdktf.IResolvable | CognitoIdentityPoolCognitoIdentityProviders[] cognito_identity_providers block.
developerProviderName string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_identity_pool#developer_provider_name CognitoIdentityPool#developer_provider_name}.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_identity_pool#id CognitoIdentityPool#id}.
openidConnectProviderArns string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_identity_pool#openid_connect_provider_arns CognitoIdentityPool#openid_connect_provider_arns}.
samlProviderArns string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_identity_pool#saml_provider_arns CognitoIdentityPool#saml_provider_arns}.
supportedLoginProviders {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_identity_pool#supported_login_providers CognitoIdentityPool#supported_login_providers}.
tags {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_identity_pool#tags CognitoIdentityPool#tags}.
tagsAll {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_identity_pool#tags_all CognitoIdentityPool#tags_all}.
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
identityPoolNameRequired 
public readonly identityPoolName: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_identity_pool#identity_pool_name CognitoIdentityPool#identity_pool_name}.

allowClassicFlowOptional 
public readonly allowClassicFlow: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_identity_pool#allow_classic_flow CognitoIdentityPool#allow_classic_flow}.

allowUnauthenticatedIdentitiesOptional 
public readonly allowUnauthenticatedIdentities: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_identity_pool#allow_unauthenticated_identities CognitoIdentityPool#allow_unauthenticated_identities}.

cognitoIdentityProvidersOptional 
public readonly cognitoIdentityProviders: IResolvable | CognitoIdentityPoolCognitoIdentityProviders[];

cognito_identity_providers block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_identity_pool#cognito_identity_providers CognitoIdentityPool#cognito_identity_providers}

developerProviderNameOptional 
public readonly developerProviderName: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_identity_pool#developer_provider_name CognitoIdentityPool#developer_provider_name}.

idOptional 
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_identity_pool#id CognitoIdentityPool#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

openidConnectProviderArnsOptional 
public readonly openidConnectProviderArns: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_identity_pool#openid_connect_provider_arns CognitoIdentityPool#openid_connect_provider_arns}.

samlProviderArnsOptional 
public readonly samlProviderArns: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_identity_pool#saml_provider_arns CognitoIdentityPool#saml_provider_arns}.

supportedLoginProvidersOptional 
public readonly supportedLoginProviders: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_identity_pool#supported_login_providers CognitoIdentityPool#supported_login_providers}.

tagsOptional 
public readonly tags: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_identity_pool#tags CognitoIdentityPool#tags}.

tagsAllOptional 
public readonly tagsAll: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cognito_identity_pool#tags_all CognitoIdentityPool#tags_all}.

Classes

CognitoIdentityPoolCognitoIdentityProvidersList

Initializers 

import { cognitoIdentityPool } from '@cdktf/aws-cdk'

new cognitoIdentityPool.CognitoIdentityPoolCognitoIdentityProvidersList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
wrapsSet boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

wrapsSetRequired
  • Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
computeFqn No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
get No description.
computeFqn 
public computeFqn(): string
resolve 
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
toString 
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

get 
public get(index: number): CognitoIdentityPoolCognitoIdentityProvidersOutputReference
indexRequired
  • Type: number

the index of the item to return.

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
internalValue cdktf.IResolvable | CognitoIdentityPoolCognitoIdentityProviders[] No description.
creationStackRequired 
public readonly creationStack: string[];
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
public readonly fqn: string;
  • Type: string
internalValueOptional 
public readonly internalValue: IResolvable | CognitoIdentityPoolCognitoIdentityProviders[];

CognitoIdentityPoolCognitoIdentityProvidersOutputReference

Initializers 

import { cognitoIdentityPool } from '@cdktf/aws-cdk'

new cognitoIdentityPool.CognitoIdentityPoolCognitoIdentityProvidersOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
complexObjectIndex number the index of this item in the list.
complexObjectIsFromSet boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

complexObjectIndexRequired
  • Type: number

the index of this item in the list.

complexObjectIsFromSetRequired
  • Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
computeFqn No description.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
resetClientId No description.
resetProviderName No description.
resetServerSideTokenCheck No description.
computeFqn 
public computeFqn(): string
getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
interpolationForAttribute 
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string
resolve 
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
toString 
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetClientId 
public resetClientId(): void
resetProviderName 
public resetProviderName(): void
resetServerSideTokenCheck 
public resetServerSideTokenCheck(): void

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
clientIdInput string No description.
providerNameInput string No description.
serverSideTokenCheckInput boolean | cdktf.IResolvable No description.
clientId string No description.
providerName string No description.
serverSideTokenCheck boolean | cdktf.IResolvable No description.
internalValue cdktf.IResolvable | CognitoIdentityPoolCognitoIdentityProviders No description.
creationStackRequired 
public readonly creationStack: string[];
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
public readonly fqn: string;
  • Type: string
clientIdInputOptional 
public readonly clientIdInput: string;
  • Type: string
providerNameInputOptional 
public readonly providerNameInput: string;
  • Type: string
serverSideTokenCheckInputOptional 
public readonly serverSideTokenCheckInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
clientIdRequired 
public readonly clientId: string;
  • Type: string
providerNameRequired 
public readonly providerName: string;
  • Type: string
serverSideTokenCheckRequired 
public readonly serverSideTokenCheck: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
internalValueOptional 
public readonly internalValue: IResolvable | CognitoIdentityPoolCognitoIdentityProviders;