Package software.amazon.awscdk.cfnpropertymixins.services.quicksight

Class CfnAgentPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.quicksight.CfnAgentPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)",
           date="2026-08-10T14:51:23.184Z")
@Stability(Stable)
public class CfnAgentPropsMixin
extends Mixin
implements software.constructs.IMixin

Resource Type definition for AWS::QuickSight::Agent.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.quicksight.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnAgentPropsMixin cfnAgentPropsMixin = CfnAgentPropsMixin.Builder.create(CfnAgentMixinProps.builder()
         .actionConnectors(List.of("actionConnectors"))
         .agentId("agentId")
         .agentLifecycle("agentLifecycle")
         .awsAccountId("awsAccountId")
         .customPromptInput(CustomPromptInputProperty.builder()
                 .existingPrompt(CustomPromptProfileProperty.builder()
                         .modelProfileId("modelProfileId")
                         .qbsAwsAccountId("qbsAwsAccountId")
                         .subscriptionId("subscriptionId")
                         .build())
                 .newPrompt(CustomPromptInputParametersProperty.builder()
                         .customInstructions("customInstructions")
                         .identity("identity")
                         .outputStyle("outputStyle")
                         .responseLength("responseLength")
                         .tone("tone")
                         .build())
                 .build())
         .description("description")
         .iconId("iconId")
         .name("name")
         .spaces(List.of("spaces"))
         .starterPrompts(List.of("starterPrompts"))
         .tags(List.of(AgentTagProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .welcomeMessage("welcomeMessage")
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-agent.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnAgentPropsMixin.AgentTagProperty	A key-value pair to associate with the agent resource.
static final class	CfnAgentPropsMixin.Builder	A fluent builder for CfnAgentPropsMixin.
static interface	CfnAgentPropsMixin.CustomPromptInputParametersProperty	Parameters for creating a new custom prompt configuration.
static interface	CfnAgentPropsMixin.CustomPromptInputProperty	Custom prompt configuration.
static interface	CfnAgentPropsMixin.CustomPromptInterfaceProperty	Read-only view of the resolved custom prompt interface for the agent.
static interface	CfnAgentPropsMixin.CustomPromptProfileProperty	Reference to an existing custom prompt profile.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnAgentPropsMixin(CfnAgentMixinProps props)	Create a mixin to apply properties to AWS::QuickSight::Agent.
	CfnAgentPropsMixin(CfnAgentMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::QuickSight::Agent.
protected	CfnAgentPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnAgentPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnAgentMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnAgentPropsMixin

protected CfnAgentPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnAgentPropsMixin

protected CfnAgentPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnAgentPropsMixin

@Stability(Stable)
public CfnAgentPropsMixin(@NotNull
 CfnAgentMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::QuickSight::Agent.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnAgentPropsMixin

@Stability(Stable)
public CfnAgentPropsMixin(@NotNull
 CfnAgentMixinProps props)

Create a mixin to apply properties to AWS::QuickSight::Agent.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnAgentMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()