Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. qbusiness
  5. WebExperience

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

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.qbusiness.WebExperience

Explore with Pulumi AI

aws-native logo

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

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

    Definition of AWS::QBusiness::WebExperience Resource Type

    Create WebExperience Resource

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

    Constructor syntax

    new WebExperience(name: string, args: WebExperienceArgs, opts?: CustomResourceOptions);
    @overload
def WebExperience(resource_name: str,
                  args: WebExperienceArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def WebExperience(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  application_id: Optional[str] = None,
                  identity_provider_configuration: Optional[Union[WebExperienceIdentityProviderConfiguration0PropertiesArgs, WebExperienceIdentityProviderConfiguration1PropertiesArgs]] = None,
                  origins: Optional[Sequence[str]] = None,
                  role_arn: Optional[str] = None,
                  sample_prompts_control_mode: Optional[WebExperienceSamplePromptsControlMode] = None,
                  subtitle: Optional[str] = None,
                  tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
                  title: Optional[str] = None,
                  welcome_message: Optional[str] = None)
    func NewWebExperience(ctx *Context, name string, args WebExperienceArgs, opts ...ResourceOption) (*WebExperience, error)
    public WebExperience(string name, WebExperienceArgs args, CustomResourceOptions? opts = null)
    public WebExperience(String name, WebExperienceArgs args)
public WebExperience(String name, WebExperienceArgs args, CustomResourceOptions options)

    type: aws-native:qbusiness:WebExperience
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

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

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

    ApplicationId string
    The identifier of the Amazon Q Business web experience.
    IdentityProviderConfiguration Pulumi.AwsNative.QBusiness.Inputs.WebExperienceIdentityProviderConfiguration0Properties | Pulumi.AwsNative.QBusiness.Inputs.WebExperienceIdentityProviderConfiguration1Properties
    Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
    Origins List<string>

    Sets the website domain origins that are allowed to embed the Amazon Q Business web experience. The domain origin refers to the base URL for accessing a website including the protocol ( http/https ), the domain name, and the port number (if specified).

    You must only submit a base URL and not a full path. For example, https://docs.aws.amazon.com .

    RoleArn string

    The Amazon Resource Name (ARN) of the service role attached to your web experience.

    You must provide this value if you're using IAM Identity Center to manage end user access to your application. If you're using legacy identity management to manage user access, you don't need to provide this value.

    SamplePromptsControlMode Pulumi.AwsNative.QBusiness.WebExperienceSamplePromptsControlMode
    Determines whether sample prompts are enabled in the web experience for an end user.
    Subtitle string
    A subtitle to personalize your Amazon Q Business web experience.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    A list of key-value pairs that identify or categorize your Amazon Q Business web experience. You can also use tags to help control access to the web experience. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
    Title string
    The title for your Amazon Q Business web experience.
    WelcomeMessage string
    A message in an Amazon Q Business web experience.
    ApplicationId string
    The identifier of the Amazon Q Business web experience.
    IdentityProviderConfiguration WebExperienceIdentityProviderConfiguration0PropertiesArgs | WebExperienceIdentityProviderConfiguration1PropertiesArgs
    Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
    Origins []string

    Sets the website domain origins that are allowed to embed the Amazon Q Business web experience. The domain origin refers to the base URL for accessing a website including the protocol ( http/https ), the domain name, and the port number (if specified).

    You must only submit a base URL and not a full path. For example, https://docs.aws.amazon.com .

    RoleArn string

    The Amazon Resource Name (ARN) of the service role attached to your web experience.

    You must provide this value if you're using IAM Identity Center to manage end user access to your application. If you're using legacy identity management to manage user access, you don't need to provide this value.

    SamplePromptsControlMode WebExperienceSamplePromptsControlMode
    Determines whether sample prompts are enabled in the web experience for an end user.
    Subtitle string
    A subtitle to personalize your Amazon Q Business web experience.
    Tags TagArgs
    A list of key-value pairs that identify or categorize your Amazon Q Business web experience. You can also use tags to help control access to the web experience. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
    Title string
    The title for your Amazon Q Business web experience.
    WelcomeMessage string
    A message in an Amazon Q Business web experience.
    applicationId String
    The identifier of the Amazon Q Business web experience.
    identityProviderConfiguration WebExperienceIdentityProviderConfiguration0Properties | WebExperienceIdentityProviderConfiguration1Properties
    Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
    origins List<String>

    Sets the website domain origins that are allowed to embed the Amazon Q Business web experience. The domain origin refers to the base URL for accessing a website including the protocol ( http/https ), the domain name, and the port number (if specified).

    You must only submit a base URL and not a full path. For example, https://docs.aws.amazon.com .

    roleArn String

    The Amazon Resource Name (ARN) of the service role attached to your web experience.

    You must provide this value if you're using IAM Identity Center to manage end user access to your application. If you're using legacy identity management to manage user access, you don't need to provide this value.

    samplePromptsControlMode WebExperienceSamplePromptsControlMode
    Determines whether sample prompts are enabled in the web experience for an end user.
    subtitle String
    A subtitle to personalize your Amazon Q Business web experience.
    tags List<Tag>
    A list of key-value pairs that identify or categorize your Amazon Q Business web experience. You can also use tags to help control access to the web experience. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
    title String
    The title for your Amazon Q Business web experience.
    welcomeMessage String
    A message in an Amazon Q Business web experience.
    applicationId string
    The identifier of the Amazon Q Business web experience.
    identityProviderConfiguration WebExperienceIdentityProviderConfiguration0Properties | WebExperienceIdentityProviderConfiguration1Properties
    Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
    origins string[]

    Sets the website domain origins that are allowed to embed the Amazon Q Business web experience. The domain origin refers to the base URL for accessing a website including the protocol ( http/https ), the domain name, and the port number (if specified).

    You must only submit a base URL and not a full path. For example, https://docs.aws.amazon.com .

    roleArn string

    The Amazon Resource Name (ARN) of the service role attached to your web experience.

    You must provide this value if you're using IAM Identity Center to manage end user access to your application. If you're using legacy identity management to manage user access, you don't need to provide this value.

    samplePromptsControlMode WebExperienceSamplePromptsControlMode
    Determines whether sample prompts are enabled in the web experience for an end user.
    subtitle string
    A subtitle to personalize your Amazon Q Business web experience.
    tags Tag[]
    A list of key-value pairs that identify or categorize your Amazon Q Business web experience. You can also use tags to help control access to the web experience. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
    title string
    The title for your Amazon Q Business web experience.
    welcomeMessage string
    A message in an Amazon Q Business web experience.
    application_id str
    The identifier of the Amazon Q Business web experience.
    identity_provider_configuration WebExperienceIdentityProviderConfiguration0PropertiesArgs | WebExperienceIdentityProviderConfiguration1PropertiesArgs
    Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
    origins Sequence[str]

    Sets the website domain origins that are allowed to embed the Amazon Q Business web experience. The domain origin refers to the base URL for accessing a website including the protocol ( http/https ), the domain name, and the port number (if specified).

    You must only submit a base URL and not a full path. For example, https://docs.aws.amazon.com .

    role_arn str

    The Amazon Resource Name (ARN) of the service role attached to your web experience.

    You must provide this value if you're using IAM Identity Center to manage end user access to your application. If you're using legacy identity management to manage user access, you don't need to provide this value.

    sample_prompts_control_mode WebExperienceSamplePromptsControlMode
    Determines whether sample prompts are enabled in the web experience for an end user.
    subtitle str
    A subtitle to personalize your Amazon Q Business web experience.
    tags Sequence[TagArgs]
    A list of key-value pairs that identify or categorize your Amazon Q Business web experience. You can also use tags to help control access to the web experience. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
    title str
    The title for your Amazon Q Business web experience.
    welcome_message str
    A message in an Amazon Q Business web experience.
    applicationId String
    The identifier of the Amazon Q Business web experience.
    identityProviderConfiguration Property Map | Property Map
    Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
    origins List<String>

    Sets the website domain origins that are allowed to embed the Amazon Q Business web experience. The domain origin refers to the base URL for accessing a website including the protocol ( http/https ), the domain name, and the port number (if specified).

    You must only submit a base URL and not a full path. For example, https://docs.aws.amazon.com .

    roleArn String

    The Amazon Resource Name (ARN) of the service role attached to your web experience.

    You must provide this value if you're using IAM Identity Center to manage end user access to your application. If you're using legacy identity management to manage user access, you don't need to provide this value.

    samplePromptsControlMode "ENABLED" | "DISABLED"
    Determines whether sample prompts are enabled in the web experience for an end user.
    subtitle String
    A subtitle to personalize your Amazon Q Business web experience.
    tags List<Property Map>
    A list of key-value pairs that identify or categorize your Amazon Q Business web experience. You can also use tags to help control access to the web experience. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
    title String
    The title for your Amazon Q Business web experience.
    welcomeMessage String
    A message in an Amazon Q Business web experience.

    Outputs

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

    CreatedAt string
    The Unix timestamp when the Amazon Q Business application was last updated.
    DefaultEndpoint string
    The endpoint URLs for your Amazon Q Business web experience. The URLs are unique and fully hosted by AWS .
    Id string
    The provider-assigned unique ID for this managed resource.
    Status Pulumi.AwsNative.QBusiness.WebExperienceStatus
    The status of your Amazon Q Business web experience.
    UpdatedAt string
    The Unix timestamp when your Amazon Q Business web experience was updated.
    WebExperienceArn string
    The Amazon Resource Name (ARN) of an Amazon Q Business web experience.
    WebExperienceId string
    The identifier of your Amazon Q Business web experience.
    CreatedAt string
    The Unix timestamp when the Amazon Q Business application was last updated.
    DefaultEndpoint string
    The endpoint URLs for your Amazon Q Business web experience. The URLs are unique and fully hosted by AWS .
    Id string
    The provider-assigned unique ID for this managed resource.
    Status WebExperienceStatus
    The status of your Amazon Q Business web experience.
    UpdatedAt string
    The Unix timestamp when your Amazon Q Business web experience was updated.
    WebExperienceArn string
    The Amazon Resource Name (ARN) of an Amazon Q Business web experience.
    WebExperienceId string
    The identifier of your Amazon Q Business web experience.
    createdAt String
    The Unix timestamp when the Amazon Q Business application was last updated.
    defaultEndpoint String
    The endpoint URLs for your Amazon Q Business web experience. The URLs are unique and fully hosted by AWS .
    id String
    The provider-assigned unique ID for this managed resource.
    status WebExperienceStatus
    The status of your Amazon Q Business web experience.
    updatedAt String
    The Unix timestamp when your Amazon Q Business web experience was updated.
    webExperienceArn String
    The Amazon Resource Name (ARN) of an Amazon Q Business web experience.
    webExperienceId String
    The identifier of your Amazon Q Business web experience.
    createdAt string
    The Unix timestamp when the Amazon Q Business application was last updated.
    defaultEndpoint string
    The endpoint URLs for your Amazon Q Business web experience. The URLs are unique and fully hosted by AWS .
    id string
    The provider-assigned unique ID for this managed resource.
    status WebExperienceStatus
    The status of your Amazon Q Business web experience.
    updatedAt string
    The Unix timestamp when your Amazon Q Business web experience was updated.
    webExperienceArn string
    The Amazon Resource Name (ARN) of an Amazon Q Business web experience.
    webExperienceId string
    The identifier of your Amazon Q Business web experience.
    created_at str
    The Unix timestamp when the Amazon Q Business application was last updated.
    default_endpoint str
    The endpoint URLs for your Amazon Q Business web experience. The URLs are unique and fully hosted by AWS .
    id str
    The provider-assigned unique ID for this managed resource.
    status WebExperienceStatus
    The status of your Amazon Q Business web experience.
    updated_at str
    The Unix timestamp when your Amazon Q Business web experience was updated.
    web_experience_arn str
    The Amazon Resource Name (ARN) of an Amazon Q Business web experience.
    web_experience_id str
    The identifier of your Amazon Q Business web experience.
    createdAt String
    The Unix timestamp when the Amazon Q Business application was last updated.
    defaultEndpoint String
    The endpoint URLs for your Amazon Q Business web experience. The URLs are unique and fully hosted by AWS .
    id String
    The provider-assigned unique ID for this managed resource.
    status "CREATING" | "ACTIVE" | "DELETING" | "FAILED" | "PENDING_AUTH_CONFIG"
    The status of your Amazon Q Business web experience.
    updatedAt String
    The Unix timestamp when your Amazon Q Business web experience was updated.
    webExperienceArn String
    The Amazon Resource Name (ARN) of an Amazon Q Business web experience.
    webExperienceId String
    The identifier of your Amazon Q Business web experience.

    Supporting Types

    Tag, TagArgs

    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

    WebExperienceIdentityProviderConfiguration0Properties, WebExperienceIdentityProviderConfiguration0PropertiesArgs

    WebExperienceIdentityProviderConfiguration1Properties, WebExperienceIdentityProviderConfiguration1PropertiesArgs

    WebExperienceOpenIdConnectProviderConfiguration, WebExperienceOpenIdConnectProviderConfigurationArgs

    SecretsArn string
    SecretsRole string
    SecretsArn string
    SecretsRole string
    secretsArn String
    secretsRole String
    secretsArn string
    secretsRole string
    secretsArn String
    secretsRole String

    WebExperienceSamlProviderConfiguration, WebExperienceSamlProviderConfigurationArgs

    WebExperienceSamplePromptsControlMode, WebExperienceSamplePromptsControlModeArgs

    Enabled
    ENABLED
    Disabled
    DISABLED
    WebExperienceSamplePromptsControlModeEnabled
    ENABLED
    WebExperienceSamplePromptsControlModeDisabled
    DISABLED
    Enabled
    ENABLED
    Disabled
    DISABLED
    Enabled
    ENABLED
    Disabled
    DISABLED
    ENABLED
    ENABLED
    DISABLED
    DISABLED
    "ENABLED"
    ENABLED
    "DISABLED"
    DISABLED

    WebExperienceStatus, WebExperienceStatusArgs

    Creating
    CREATING
    Active
    ACTIVE
    Deleting
    DELETING
    Failed
    FAILED
    PendingAuthConfig
    PENDING_AUTH_CONFIG
    WebExperienceStatusCreating
    CREATING
    WebExperienceStatusActive
    ACTIVE
    WebExperienceStatusDeleting
    DELETING
    WebExperienceStatusFailed
    FAILED
    WebExperienceStatusPendingAuthConfig
    PENDING_AUTH_CONFIG
    Creating
    CREATING
    Active
    ACTIVE
    Deleting
    DELETING
    Failed
    FAILED
    PendingAuthConfig
    PENDING_AUTH_CONFIG
    Creating
    CREATING
    Active
    ACTIVE
    Deleting
    DELETING
    Failed
    FAILED
    PendingAuthConfig
    PENDING_AUTH_CONFIG
    CREATING
    CREATING
    ACTIVE
    ACTIVE
    DELETING
    DELETING
    FAILED
    FAILED
    PENDING_AUTH_CONFIG
    PENDING_AUTH_CONFIG
    "CREATING"
    CREATING
    "ACTIVE"
    ACTIVE
    "DELETING"
    DELETING
    "FAILED"
    FAILED
    "PENDING_AUTH_CONFIG"
    PENDING_AUTH_CONFIG

    Package Details

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

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

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-aws-native