CfnUser

class aws_cdk.aws_identitystore.CfnUser(scope, id, *, identity_store_id, addresses=None, birthdate=None, display_name=None, emails=None, locale=None, name=None, nick_name=None, phone_numbers=None, photos=None, preferred_language=None, profile_url=None, roles=None, timezone=None, title=None, user_name=None, user_type=None, website=None)

Bases: CfnResource

Creates a user within the specified identity store.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-identitystore-user.html

CloudformationResource:

AWS::IdentityStore::User

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_identitystore as identitystore

cfn_user = identitystore.CfnUser(self, "MyCfnUser",
    identity_store_id="identityStoreId",

    # the properties below are optional
    addresses=[identitystore.CfnUser.AddressesItemsProperty(
        country="country",
        formatted="formatted",
        locality="locality",
        postal_code="postalCode",
        primary=False,
        region="region",
        street_address="streetAddress",
        type="type"
    )],
    birthdate="birthdate",
    display_name="displayName",
    emails=[identitystore.CfnUser.EmailsItemsProperty(
        primary=False,
        type="type",
        value="value"
    )],
    locale="locale",
    name=identitystore.CfnUser.NameProperty(
        family_name="familyName",
        formatted="formatted",
        given_name="givenName",
        honorific_prefix="honorificPrefix",
        honorific_suffix="honorificSuffix",
        middle_name="middleName"
    ),
    nick_name="nickName",
    phone_numbers=[identitystore.CfnUser.PhoneNumbersItemsProperty(
        primary=False,
        type="type",
        value="value"
    )],
    photos=[identitystore.CfnUser.PhotosItemsProperty(
        value="value",

        # the properties below are optional
        display="display",
        primary=False,
        type="type"
    )],
    preferred_language="preferredLanguage",
    profile_url="profileUrl",
    roles=[identitystore.CfnUser.RolesItemsProperty(
        primary=False,
        type="type",
        value="value"
    )],
    timezone="timezone",
    title="title",
    user_name="userName",
    user_type="userType",
    website="website"
)

Create a new AWS::IdentityStore::User.

Parameters:
  • scope (Construct) – Scope in which this resource is defined.

  • id (str) – Construct identifier for this resource (unique in its scope).

  • identity_store_id (str) – The globally unique identifier for the identity store.

  • addresses (Union[IResolvable, Sequence[Union[IResolvable, AddressesItemsProperty, Dict[str, Any]]], None]) – A list of addresses associated with the user.

  • birthdate (Optional[str]) – The user’s birthdate in YYYY-MM-DD format.

  • display_name (Optional[str]) – A string containing the name of the user for display.

  • emails (Union[IResolvable, Sequence[Union[IResolvable, EmailsItemsProperty, Dict[str, Any]]], None]) – A list of email addresses associated with the user.

  • locale (Optional[str]) – The geographical region or location of the user.

  • name (Union[IResolvable, NameProperty, Dict[str, Any], None]) – The name of the user.

  • nick_name (Optional[str]) – An alternate name for the user.

  • phone_numbers (Union[IResolvable, Sequence[Union[IResolvable, PhoneNumbersItemsProperty, Dict[str, Any]]], None]) – A list of phone numbers associated with the user.

  • photos (Union[IResolvable, Sequence[Union[IResolvable, PhotosItemsProperty, Dict[str, Any]]], None]) – A list of photos associated with the user.

  • preferred_language (Optional[str]) – The preferred language of the user.

  • profile_url (Optional[str]) – A URL associated with the user.

  • roles (Union[IResolvable, Sequence[Union[IResolvable, RolesItemsProperty, Dict[str, Any]]], None]) – A list of roles associated with the user.

  • timezone (Optional[str]) – The time zone for the user.

  • title (Optional[str]) – The title of the user.

  • user_name (Optional[str]) – A unique string used to identify the user.

  • user_type (Optional[str]) – A string indicating the type of user.

  • website (Optional[str]) – The user’s personal website or blog URL.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:

path (str) – The path of the value to delete.

Return type:

None

add_dependency(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This method has been renamed to addResourceDependency to more clearly set it apart from construct.node.addDependency. See the documentation of that function for more details.

Parameters:

target (CfnResource)

Deprecated:

Use addResourceDependency instead.

Stability:

deprecated

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method has been renamed to addResourceDependency, which makes it more clear that this method operates at a different level from the construct-level construct.node.addDependency() mechanism.

Parameters:

target (CfnResource)

Deprecated:

Use addResourceDependency instead.

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:
  • key (str)

  • value (Any)

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:

property_path (str) – The path to the property.

Return type:

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type:

None

add_resource_dependency(target, reason=None)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use construct.node.addDependency instead.

Parameters:
Return type:

None

apply_cross_stack_reference_strength(strength)

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack’s context.

Parameters:

strength (ReferenceStrength) –

  • The reference strength to use for this resource.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:
  • policy (Optional[RemovalPolicy])

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

cfn_property_name(cdk_property_name)
Parameters:

cdk_property_name (str)

Return type:

Optional[str]

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:
  • attribute_name (str) – The name of the attribute.

  • type_hint (Optional[ResolutionTypeHint])

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str)

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) – tree inspector to collect and process attributes.

Return type:

None

obtain_dependencies()

Retrieves an array of resources and stacks this resource depends on.

For resources depended on directly, returns the CfnResource object. For dependencies on other stacks, returns the Stack object. The order of the array is not guaranteed.

Return type:

List[Union[Stack, CfnResource]]

override_logical_id(new_logical_id)

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

Parameters:

new_logical_id (str) – The new logical ID to use for this stack element.

Return type:

None

remove_dependency(target)

(deprecated) Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource)

Deprecated:

Use removeResourceDependency instead

Stability:

deprecated

Return type:

None

remove_resource_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource)

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:
Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

with_(*mixins)

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

mixins (IMixin)

Return type:

IConstruct

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::IdentityStore::User'
addresses

A list of addresses associated with the user.

attr_arn

The Amazon Resource Name (ARN) of the user.

CloudformationAttribute:

Arn

attr_created_at

The date and time the user was created.

CloudformationAttribute:

CreatedAt

attr_created_by

The identifier of the user or system that created the user.

CloudformationAttribute:

CreatedBy

attr_updated_at

The date and time the user was last updated.

CloudformationAttribute:

UpdatedAt

attr_updated_by

The identifier of the user or system that last updated the user.

CloudformationAttribute:

UpdatedBy

attr_user_id

The identifier for a user in the identity store.

CloudformationAttribute:

UserId

attr_user_status

The current status of the user account.

CloudformationAttribute:

UserStatus

birthdate

The user’s birthdate in YYYY-MM-DD format.

cfn_options

Options for this resource, such as condition, update policy etc.

cfn_resource_type

AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

display_name

A string containing the name of the user for display.

emails

A list of email addresses associated with the user.

env
identity_store_id

The globally unique identifier for the identity store.

locale

The geographical region or location of the user.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

name

The name of the user.

nick_name

An alternate name for the user.

node

The tree node.

phone_numbers

A list of phone numbers associated with the user.

photos

A list of photos associated with the user.

preferred_language

The preferred language of the user.

profile_url

A URL associated with the user.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

roles

A list of roles associated with the user.

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

timezone

The time zone for the user.

title

The title of the user.

user_name

A unique string used to identify the user.

user_ref

A reference to a User resource.

user_type

A string indicating the type of user.

website

The user’s personal website or blog URL.

Static Methods

classmethod arn_for_user(resource)
Parameters:

resource (IUserRef)

Return type:

str

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any)

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any)

Return type:

bool

classmethod is_cfn_user(x)

Checks whether the given object is a CfnUser.

Parameters:

x (Any)

Return type:

bool

classmethod is_construct(x)

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.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

AddressesItemsProperty

class CfnUser.AddressesItemsProperty(*, country=None, formatted=None, locality=None, postal_code=None, primary=None, region=None, street_address=None, type=None)

Bases: object

Parameters:
  • country (Optional[str]) – The country of the address.

  • formatted (Optional[str]) – A formatted version of the address for display.

  • locality (Optional[str]) – A string of the address locality.

  • postal_code (Optional[str]) – The postal code of the address.

  • primary (Union[bool, IResolvable, None]) – Whether this is the primary address.

  • region (Optional[str]) – The region of the address.

  • street_address (Optional[str]) – The street of the address.

  • type (Optional[str]) – The type of address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-addressesitems.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_identitystore as identitystore

addresses_items_property = identitystore.CfnUser.AddressesItemsProperty(
    country="country",
    formatted="formatted",
    locality="locality",
    postal_code="postalCode",
    primary=False,
    region="region",
    street_address="streetAddress",
    type="type"
)

Attributes

country

The country of the address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-addressesitems.html#cfn-identitystore-user-addressesitems-country

formatted

A formatted version of the address for display.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-addressesitems.html#cfn-identitystore-user-addressesitems-formatted

locality

A string of the address locality.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-addressesitems.html#cfn-identitystore-user-addressesitems-locality

postal_code

The postal code of the address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-addressesitems.html#cfn-identitystore-user-addressesitems-postalcode

primary

Whether this is the primary address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-addressesitems.html#cfn-identitystore-user-addressesitems-primary

region

The region of the address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-addressesitems.html#cfn-identitystore-user-addressesitems-region

street_address

The street of the address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-addressesitems.html#cfn-identitystore-user-addressesitems-streetaddress

type

The type of address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-addressesitems.html#cfn-identitystore-user-addressesitems-type

EmailsItemsProperty

class CfnUser.EmailsItemsProperty(*, primary=None, type=None, value=None)

Bases: object

Parameters:
  • primary (Union[bool, IResolvable, None]) – Whether this is the primary email address.

  • type (Optional[str]) – The type of email address.

  • value (Optional[str]) – The email address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-emailsitems.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_identitystore as identitystore

emails_items_property = identitystore.CfnUser.EmailsItemsProperty(
    primary=False,
    type="type",
    value="value"
)

Attributes

primary

Whether this is the primary email address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-emailsitems.html#cfn-identitystore-user-emailsitems-primary

type

The type of email address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-emailsitems.html#cfn-identitystore-user-emailsitems-type

value

The email address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-emailsitems.html#cfn-identitystore-user-emailsitems-value

NameProperty

class CfnUser.NameProperty(*, family_name=None, formatted=None, given_name=None, honorific_prefix=None, honorific_suffix=None, middle_name=None)

Bases: object

The name of the user.

Parameters:
  • family_name (Optional[str]) – The family name of the user.

  • formatted (Optional[str]) – A string containing a formatted version of the name for display.

  • given_name (Optional[str]) – The given name of the user.

  • honorific_prefix (Optional[str]) – The honorific prefix of the user.

  • honorific_suffix (Optional[str]) – The honorific suffix of the user.

  • middle_name (Optional[str]) – The middle name of the user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-name.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_identitystore as identitystore

name_property = identitystore.CfnUser.NameProperty(
    family_name="familyName",
    formatted="formatted",
    given_name="givenName",
    honorific_prefix="honorificPrefix",
    honorific_suffix="honorificSuffix",
    middle_name="middleName"
)

Attributes

family_name

The family name of the user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-name.html#cfn-identitystore-user-name-familyname

formatted

A string containing a formatted version of the name for display.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-name.html#cfn-identitystore-user-name-formatted

given_name

The given name of the user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-name.html#cfn-identitystore-user-name-givenname

honorific_prefix

The honorific prefix of the user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-name.html#cfn-identitystore-user-name-honorificprefix

honorific_suffix

The honorific suffix of the user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-name.html#cfn-identitystore-user-name-honorificsuffix

middle_name

The middle name of the user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-name.html#cfn-identitystore-user-name-middlename

PhoneNumbersItemsProperty

class CfnUser.PhoneNumbersItemsProperty(*, primary=None, type=None, value=None)

Bases: object

Parameters:
  • primary (Union[bool, IResolvable, None]) – Whether this is the primary phone number.

  • type (Optional[str]) – The type of phone number.

  • value (Optional[str]) – The phone number.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-phonenumbersitems.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_identitystore as identitystore

phone_numbers_items_property = identitystore.CfnUser.PhoneNumbersItemsProperty(
    primary=False,
    type="type",
    value="value"
)

Attributes

primary

Whether this is the primary phone number.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-phonenumbersitems.html#cfn-identitystore-user-phonenumbersitems-primary

type

The type of phone number.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-phonenumbersitems.html#cfn-identitystore-user-phonenumbersitems-type

value

The phone number.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-phonenumbersitems.html#cfn-identitystore-user-phonenumbersitems-value

PhotosItemsProperty

class CfnUser.PhotosItemsProperty(*, value, display=None, primary=None, type=None)

Bases: object

Parameters:
  • value (str) – The photo data or URL.

  • display (Optional[str]) – A display name for the photo.

  • primary (Union[bool, IResolvable, None]) – Whether this is the primary photo.

  • type (Optional[str]) – The type of photo.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-photositems.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_identitystore as identitystore

photos_items_property = identitystore.CfnUser.PhotosItemsProperty(
    value="value",

    # the properties below are optional
    display="display",
    primary=False,
    type="type"
)

Attributes

display

A display name for the photo.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-photositems.html#cfn-identitystore-user-photositems-display

primary

Whether this is the primary photo.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-photositems.html#cfn-identitystore-user-photositems-primary

type

The type of photo.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-photositems.html#cfn-identitystore-user-photositems-type

value

The photo data or URL.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-photositems.html#cfn-identitystore-user-photositems-value

RolesItemsProperty

class CfnUser.RolesItemsProperty(*, primary=None, type=None, value=None)

Bases: object

Parameters:
  • primary (Union[bool, IResolvable, None]) – Whether this is the primary role.

  • type (Optional[str]) – The type of role.

  • value (Optional[str]) – The role name.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-rolesitems.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_identitystore as identitystore

roles_items_property = identitystore.CfnUser.RolesItemsProperty(
    primary=False,
    type="type",
    value="value"
)

Attributes

primary

Whether this is the primary role.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-rolesitems.html#cfn-identitystore-user-rolesitems-primary

type

The type of role.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-rolesitems.html#cfn-identitystore-user-rolesitems-type

value

The role name.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-user-rolesitems.html#cfn-identitystore-user-rolesitems-value