1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. bedrockagentcore
  6. ConsentPortal

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.86.0
published on Wednesday, Nov 18, 2026 by Pulumi
aws-native logo aws-native logo AWS Cloud Control

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.86.0
published on Wednesday, Nov 18, 2026 by Pulumi

    Resource Type definition for AWS::BedrockAgentCore::ConsentPortal

    Create ConsentPortal Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ConsentPortal(name: string, args: ConsentPortalArgs, opts?: CustomResourceOptions);
    @overload
    def ConsentPortal(resource_name: str,
                      args: ConsentPortalArgs,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def ConsentPortal(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      execution_role_arn: Optional[str] = None,
                      idp_config: Optional[ConsentPortalIdpConfigArgs] = None,
                      sources: Optional[Sequence[ConsentPortalSourceArgs]] = None,
                      description: Optional[str] = None,
                      name: Optional[str] = None,
                      tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewConsentPortal(ctx *Context, name string, args ConsentPortalArgs, opts ...ResourceOption) (*ConsentPortal, error)
    public ConsentPortal(string name, ConsentPortalArgs args, CustomResourceOptions? opts = null)
    public ConsentPortal(String name, ConsentPortalArgs args)
    public ConsentPortal(String name, ConsentPortalArgs args, CustomResourceOptions options)
    
    type: aws-native:bedrockagentcore:ConsentPortal
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "aws-native_bedrockagentcore_consent_portal" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args ConsentPortalArgs
    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 ConsentPortalArgs
    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 ConsentPortalArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConsentPortalArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConsentPortalArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    ConsentPortal 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 ConsentPortal resource accepts the following input properties:

    execution_role_arn string
    idp_config object
    sources list(object)
    description string
    name string
    tags list(object)
    Tags to assign to the consent portal

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ConsentPortal resource produces the following output properties:

    ConsentPortalArn string
    The Amazon Resource Name (ARN) of the resource.
    ConsentPortalId string
    CreatedAt string
    Id string
    The provider-assigned unique ID for this managed resource.
    PortalUrl string
    Status Pulumi.AwsNative.BedrockAgentCore.ConsentPortalStatus
    UpdatedAt string
    ConsentPortalArn string
    The Amazon Resource Name (ARN) of the resource.
    ConsentPortalId string
    CreatedAt string
    Id string
    The provider-assigned unique ID for this managed resource.
    PortalUrl string
    Status ConsentPortalStatus
    UpdatedAt string
    consent_portal_arn string
    The Amazon Resource Name (ARN) of the resource.
    consent_portal_id string
    created_at string
    id string
    The provider-assigned unique ID for this managed resource.
    portal_url string
    status "CREATING" | "ACTIVE" | "UPDATING" | "UPDATE_FAILED" | "DELETING" | "FAILED"
    updated_at string
    consentPortalArn String
    The Amazon Resource Name (ARN) of the resource.
    consentPortalId String
    createdAt String
    id String
    The provider-assigned unique ID for this managed resource.
    portalUrl String
    status ConsentPortalStatus
    updatedAt String
    consentPortalArn string
    The Amazon Resource Name (ARN) of the resource.
    consentPortalId string
    createdAt string
    id string
    The provider-assigned unique ID for this managed resource.
    portalUrl string
    status ConsentPortalStatus
    updatedAt string
    consent_portal_arn str
    The Amazon Resource Name (ARN) of the resource.
    consent_portal_id str
    created_at str
    id str
    The provider-assigned unique ID for this managed resource.
    portal_url str
    status ConsentPortalStatus
    updated_at str
    consentPortalArn String
    The Amazon Resource Name (ARN) of the resource.
    consentPortalId String
    createdAt String
    id String
    The provider-assigned unique ID for this managed resource.
    portalUrl String
    status "CREATING" | "ACTIVE" | "UPDATING" | "UPDATE_FAILED" | "DELETING" | "FAILED"
    updatedAt String

    Look up Existing ConsentPortal Resource

    Get an existing ConsentPortal resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, opts?: CustomResourceOptions): ConsentPortal
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None) -> ConsentPortal
    func GetConsentPortal(ctx *Context, name string, id IDInput, state *ConsentPortalState, opts ...ResourceOption) (*ConsentPortal, error)
    public static ConsentPortal Get(string name, Input<string> id, CustomResourceOptions? opts = null)
    public static ConsentPortal get(String name, Output<String> id, CustomResourceOptions options)
    resources:  existingConsentPortal:    type: aws-native:bedrockagentcore:ConsentPortal    get:      id: ${id}
    import {
      to = aws-native_bedrockagentcore_consent_portal.example
      id = "${id}"
    }
    
    name string
    The unique name of the resulting resource.
    id Input<ID>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resulting resource.
    id str
    The unique provider ID of the resource to look up.
    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 resulting resource.
    id IDInput
    The unique provider ID of the resource to look up.
    state ConsentPortalState
    Pass nil. This resource has no state arguments.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resulting resource.
    id Input<string>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resulting resource.
    id Output<String>
    The unique provider ID of the resource to look up.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Supporting Types

    ConsentPortalIdpConfig, ConsentPortalIdpConfigArgs

    CredentialProviderArn string
    The ARN of an AWS::BedrockAgentCore::OAuth2CredentialProvider resource.
    Scopes List<string>
    Audience string
    CredentialProviderArn string
    The ARN of an AWS::BedrockAgentCore::OAuth2CredentialProvider resource.
    Scopes []string
    Audience string
    credential_provider_arn string
    The ARN of an AWS::BedrockAgentCore::OAuth2CredentialProvider resource.
    scopes list(string)
    audience string
    credentialProviderArn String
    The ARN of an AWS::BedrockAgentCore::OAuth2CredentialProvider resource.
    scopes List<String>
    audience String
    credentialProviderArn string
    The ARN of an AWS::BedrockAgentCore::OAuth2CredentialProvider resource.
    scopes string[]
    audience string
    credential_provider_arn str
    The ARN of an AWS::BedrockAgentCore::OAuth2CredentialProvider resource.
    scopes Sequence[str]
    audience str
    credentialProviderArn String
    The ARN of an AWS::BedrockAgentCore::OAuth2CredentialProvider resource.
    scopes List<String>
    audience String

    ConsentPortalSource, ConsentPortalSourceArgs

    ConsentPortalSourceType

    NameValue
    AgentcoreGatewayagentcore-gateway
    NameValue
    ConsentPortalSourceTypeAgentcoreGatewayagentcore-gateway
    Value
    agentcore-gateway
    NameValue
    AgentcoreGatewayagentcore-gateway
    NameValue
    AgentcoreGatewayagentcore-gateway
    NameValue
    AGENTCORE_GATEWAYagentcore-gateway
    Value
    agentcore-gateway

    ConsentPortalStatus

    NameValue
    CreatingCREATING
    ActiveACTIVE
    UpdatingUPDATING
    UpdateFailedUPDATE_FAILED
    DeletingDELETING
    FailedFAILED
    NameValue
    ConsentPortalStatusCreatingCREATING
    ConsentPortalStatusActiveACTIVE
    ConsentPortalStatusUpdatingUPDATING
    ConsentPortalStatusUpdateFailedUPDATE_FAILED
    ConsentPortalStatusDeletingDELETING
    ConsentPortalStatusFailedFAILED
    Value
    CREATING
    ACTIVE
    UPDATING
    UPDATE_FAILED
    DELETING
    FAILED
    NameValue
    CreatingCREATING
    ActiveACTIVE
    UpdatingUPDATING
    UpdateFailedUPDATE_FAILED
    DeletingDELETING
    FailedFAILED
    NameValue
    CreatingCREATING
    ActiveACTIVE
    UpdatingUPDATING
    UpdateFailedUPDATE_FAILED
    DeletingDELETING
    FailedFAILED
    NameValue
    CREATINGCREATING
    ACTIVEACTIVE
    UPDATINGUPDATING
    UPDATE_FAILEDUPDATE_FAILED
    DELETINGDELETING
    FAILEDFAILED
    Value
    CREATING
    ACTIVE
    UPDATING
    UPDATE_FAILED
    DELETING
    FAILED

    Tag, TagArgs

    A set of tags to apply to the resource.

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo AWS Cloud Control

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.86.0
    published on Wednesday, Nov 18, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial