class CfnAgentPropsMixin (mixin)

Language	Type name
.NET	Amazon.CDK.CfnPropertyMixins.AWS.QuickSight.CfnAgentPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awsquicksight#CfnAgentPropsMixin
Java	software.amazon.awscdk.cfnpropertymixins.services.quicksight.CfnAgentPropsMixin
Python	aws_cdk.cfn_property_mixins.aws_quicksight.CfnAgentPropsMixin
TypeScript	@aws-cdk/cfn-property-mixins » aws_quicksight » CfnAgentPropsMixin

Implements IMixin

Extends Mixin

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

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_quicksight as quicksight } from '@aws-cdk/cfn-property-mixins';
import * as cdk from 'aws-cdk-lib';

declare const mergeStrategy: cdk.IMergeStrategy;
const cfnAgentPropsMixin = new quicksight.CfnAgentPropsMixin({
  actionConnectors: ['actionConnectors'],
  agentId: 'agentId',
  agentLifecycle: 'agentLifecycle',
  awsAccountId: 'awsAccountId',
  customPromptInput: {
    existingPrompt: {
      modelProfileId: 'modelProfileId',
      qbsAwsAccountId: 'qbsAwsAccountId',
      subscriptionId: 'subscriptionId',
    },
    newPrompt: {
      customInstructions: 'customInstructions',
      identity: 'identity',
      outputStyle: 'outputStyle',
      responseLength: 'responseLength',
      tone: 'tone',
    },
  },
  description: 'description',
  iconId: 'iconId',
  name: 'name',
  spaces: ['spaces'],
  starterPrompts: ['starterPrompts'],
  tags: [{
    key: 'key',
    value: 'value',
  }],
  welcomeMessage: 'welcomeMessage',
}, /* all optional props */ {
  strategy: mergeStrategy,
});

Initializer

new CfnAgentPropsMixin(props: CfnAgentMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnAgentMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

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

Properties

Name	Type	Description
props	CfnAgentMixinProps
strategy	IMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnAgentMixinProps

---

strategy

Type: IMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): void

Parameters

• construct IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.