View a markdown version of this page

AWS::BedrockAgentCore::ConsentPortal - AWS CloudFormation
SyntaxPropertiesReturn values

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.

AWS::BedrockAgentCore::ConsentPortal

Creates a new consent portal.

Syntax

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

JSON

{
  "Type" : "AWS::BedrockAgentCore::ConsentPortal",
  "Properties" : {
      "Description" : String,
      "ExecutionRoleArn" : String,
      "IdpConfig" : IdpConfig,
      "Name" : String,
      "Sources" : [ ConsentPortalSource, ... ],
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::BedrockAgentCore::ConsentPortal
Properties:
  Description: String
  ExecutionRoleArn: String
  IdpConfig: 
    IdpConfig
  Name: String
  Sources: 
    - ConsentPortalSource
  Tags: 
    - Tag

Properties

Description

The description of the consent portal.

Required: No

Type: String

Maximum: 512

Update requires: No interruption

ExecutionRoleArn

Property description not available.

Required: Yes

Type: String

Pattern: ^arn:aws(-[a-z-]+)?:iam::[0-9]{12}:role/[a-zA-Z0-9+=,.@\-_/]+$

Update requires: No interruption

IdpConfig

Property description not available.

Required: Yes

Type: IdpConfig

Update requires: No interruption

Name

The name of the consent portal.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9_-]{1,50}$

Minimum: 1

Maximum: 50

Update requires: Replacement

Sources

The resources served by the consent portal.

Required: Yes

Type: Array of ConsentPortalSource

Minimum: 1

Maximum: 1

Update requires: Replacement

Tags

Property description not available.

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

Return values

Ref

Fn::GetAtt

ConsentPortalArn

The Amazon Resource Name (ARN) of the consent portal.

ConsentPortalId

The unique identifier of the consent portal.

CreatedAt

The timestamp for when the consent portal was created.

PortalUrl

The URL used to access the consent portal.

Status

The current status of the consent portal.

UpdatedAt

The timestamp for when the consent portal was last updated.