

This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::MPA::IdentitySource
<a name="aws-resource-mpa-identitysource"></a>

Creates a new identity source. For more information, see [Identity Source](https://docs.aws.amazon.com/mpa/latest/userguide/mpa-concepts.html) in the *Multi-party approval User Guide*.

## Syntax
<a name="aws-resource-mpa-identitysource-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-mpa-identitysource-syntax.json"></a>

```
{
  "Type" : "AWS::MPA::IdentitySource",
  "Properties" : {
      "[IdentitySourceParameters](#cfn-mpa-identitysource-identitysourceparameters)" : IdentitySourceParameters,
      "[Tags](#cfn-mpa-identitysource-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-mpa-identitysource-syntax.yaml"></a>

```
Type: AWS::MPA::IdentitySource
Properties:
  [IdentitySourceParameters](#cfn-mpa-identitysource-identitysourceparameters): 
    IdentitySourceParameters
  [Tags](#cfn-mpa-identitysource-tags): 
    - Tag
```

## Properties
<a name="aws-resource-mpa-identitysource-properties"></a>

`IdentitySourceParameters`  <a name="cfn-mpa-identitysource-identitysourceparameters"></a>
A ` IdentitySourceParameters` object. Contains details for the resource that provides identities to the identity source. For example, an IAM Identity Center instance.  
*Required*: Yes  
*Type*: [IdentitySourceParameters](aws-properties-mpa-identitysource-identitysourceparameters.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-mpa-identitysource-tags"></a>
Tags that you have added to the specified resource.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-mpa-identitysource-tag.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-mpa-identitysource-return-values"></a>

### Ref
<a name="aws-resource-mpa-identitysource-return-values-ref"></a>

### Fn::GetAtt
<a name="aws-resource-mpa-identitysource-return-values-fn--getatt"></a>

#### 
<a name="aws-resource-mpa-identitysource-return-values-fn--getatt-fn--getatt"></a>

`CreationTime`  <a name="CreationTime-fn::getatt"></a>
Timestamp when the identity source was created.

`IdentitySourceArn`  <a name="IdentitySourceArn-fn::getatt"></a>
Amazon Resource Name (ARN) for the identity source.

`IdentitySourceParameters.IamIdentityCenter.ApprovalPortalUrl`  <a name="IdentitySourceParameters.IamIdentityCenter.ApprovalPortalUrl-fn::getatt"></a>
URL for the approval portal associated with the IAM Identity Center instance.

`IdentitySourceType`  <a name="IdentitySourceType-fn::getatt"></a>
The type of resource that provided identities to the identity source. For example, an IAM Identity Center instance.

`Status`  <a name="Status-fn::getatt"></a>
Status for the identity source. For example, if the identity source is `ACTIVE`.

`StatusCode`  <a name="StatusCode-fn::getatt"></a>
Status code of the identity source.

`StatusMessage`  <a name="StatusMessage-fn::getatt"></a>
Message describing the status for the identity source.

# AWS::MPA::IdentitySource IamIdentityCenter
<a name="aws-properties-mpa-identitysource-iamidentitycenter"></a>

AWS IAM Identity Center credentials. For more information see, [AWS IAM Identity Center](https://aws.amazon.com/identity-center/) .

## Syntax
<a name="aws-properties-mpa-identitysource-iamidentitycenter-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-mpa-identitysource-iamidentitycenter-syntax.json"></a>

```
{
  "[ApprovalPortalUrl](#cfn-mpa-identitysource-iamidentitycenter-approvalportalurl)" : String,
  "[InstanceArn](#cfn-mpa-identitysource-iamidentitycenter-instancearn)" : String,
  "[Region](#cfn-mpa-identitysource-iamidentitycenter-region)" : String
}
```

### YAML
<a name="aws-properties-mpa-identitysource-iamidentitycenter-syntax.yaml"></a>

```
  [ApprovalPortalUrl](#cfn-mpa-identitysource-iamidentitycenter-approvalportalurl): String
  [InstanceArn](#cfn-mpa-identitysource-iamidentitycenter-instancearn): String
  [Region](#cfn-mpa-identitysource-iamidentitycenter-region): String
```

## Properties
<a name="aws-properties-mpa-identitysource-iamidentitycenter-properties"></a>

`ApprovalPortalUrl`  <a name="cfn-mpa-identitysource-iamidentitycenter-approvalportalurl"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`InstanceArn`  <a name="cfn-mpa-identitysource-iamidentitycenter-instancearn"></a>
Amazon Resource Name (ARN) for the IAM Identity Center instance.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^arn:.+:sso:::instance/(?:sso)?ins-[a-zA-Z0-9-.]{16}$`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Region`  <a name="cfn-mpa-identitysource-iamidentitycenter-region"></a>
AWS Region where the IAM Identity Center instance is located.  
*Required*: Yes  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::MPA::IdentitySource IdentitySourceParameters
<a name="aws-properties-mpa-identitysource-identitysourceparameters"></a>

Contains details for the resource that provides identities to the identity source. For example, an IAM Identity Center instance.

## Syntax
<a name="aws-properties-mpa-identitysource-identitysourceparameters-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-mpa-identitysource-identitysourceparameters-syntax.json"></a>

```
{
  "[IamIdentityCenter](#cfn-mpa-identitysource-identitysourceparameters-iamidentitycenter)" : IamIdentityCenter
}
```

### YAML
<a name="aws-properties-mpa-identitysource-identitysourceparameters-syntax.yaml"></a>

```
  [IamIdentityCenter](#cfn-mpa-identitysource-identitysourceparameters-iamidentitycenter): 
    IamIdentityCenter
```

## Properties
<a name="aws-properties-mpa-identitysource-identitysourceparameters-properties"></a>

`IamIdentityCenter`  <a name="cfn-mpa-identitysource-identitysourceparameters-iamidentitycenter"></a>
AWS IAM Identity Center credentials.  
*Required*: Yes  
*Type*: [IamIdentityCenter](aws-properties-mpa-identitysource-iamidentitycenter.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::MPA::IdentitySource Tag
<a name="aws-properties-mpa-identitysource-tag"></a>

Tags that you have added to the specified resource.

## Syntax
<a name="aws-properties-mpa-identitysource-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-mpa-identitysource-tag-syntax.json"></a>

```
{
  "[Key](#cfn-mpa-identitysource-tag-key)" : String,
  "[Value](#cfn-mpa-identitysource-tag-value)" : String
}
```

### YAML
<a name="aws-properties-mpa-identitysource-tag-syntax.yaml"></a>

```
  [Key](#cfn-mpa-identitysource-tag-key): String
  [Value](#cfn-mpa-identitysource-tag-value): String
```

## Properties
<a name="aws-properties-mpa-identitysource-tag-properties"></a>

`Key`  <a name="cfn-mpa-identitysource-tag-key"></a>
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.   
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-mpa-identitysource-tag-value"></a>
One part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)