CfnAgent
- class aws_cdk.aws_quicksight.CfnAgent(scope, id, *, agent_id, aws_account_id, name, action_connectors=None, agent_lifecycle=None, custom_prompt_input=None, description=None, icon_id=None, spaces=None, starter_prompts=None, tags=None, welcome_message=None)
Bases:
CfnResourceResource Type definition for AWS::QuickSight::Agent.
- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-agent.html
- CloudformationResource:
AWS::QuickSight::Agent
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_quicksight as quicksight cfn_agent = quicksight.CfnAgent(self, "MyCfnAgent", agent_id="agentId", aws_account_id="awsAccountId", name="name", # the properties below are optional action_connectors=["actionConnectors"], agent_lifecycle="agentLifecycle", custom_prompt_input=quicksight.CfnAgent.CustomPromptInputProperty( existing_prompt=quicksight.CfnAgent.CustomPromptProfileProperty( model_profile_id="modelProfileId", qbs_aws_account_id="qbsAwsAccountId", subscription_id="subscriptionId" ), new_prompt=quicksight.CfnAgent.CustomPromptInputParametersProperty( custom_instructions="customInstructions", identity="identity", output_style="outputStyle", response_length="responseLength", tone="tone" ) ), description="description", icon_id="iconId", spaces=["spaces"], starter_prompts=["starterPrompts"], tags=[quicksight.CfnAgent.AgentTagProperty( key="key", value="value" )], welcome_message="welcomeMessage" )
Create a new
AWS::QuickSight::Agent.- Parameters:
scope (
Construct) – Scope in which this resource is defined.id (
str) – Construct identifier for this resource (unique in its scope).agent_id (
str) – The unique identifier for the agent.aws_account_id (
str) – The ID of the Amazon Web Services account where the agent is being created.name (
str) – The display name of the agent.action_connectors (
Optional[Sequence[str]]) – A list of ActionConnector ARNs (max 10) attached to the agent.agent_lifecycle (
Optional[str]) – The lifecycle stage of the agent. PREVIEW or PUBLISHED.custom_prompt_input (
Union[IResolvable,CustomPromptInputProperty,Dict[str,Any],None]) – Custom prompt configuration. Specify either ExistingPrompt or NewPrompt.description (
Optional[str]) – A description of the agent.icon_id (
Optional[str]) – The icon identifier for the agent.spaces (
Optional[Sequence[str]]) – A list of Space ARNs (max 10) attached to the agent.starter_prompts (
Optional[Sequence[str]]) – A list of up to 3 starter prompts displayed to users.tags (
Optional[Sequence[Union[AgentTagProperty,Dict[str,Any]]]]) – A list of key-value pairs to associate with the agent resource.welcome_message (
Optional[str]) – The welcome message displayed when a user opens the agent.
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined).- Parameters:
path (
str) – The path of the value to delete.- Return type:
None
- add_dependency(target)
(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This method has been renamed to
addResourceDependencyto more clearly set it apart fromconstruct.node.addDependency. See the documentation of that function for more details.- Parameters:
target (
CfnResource)- Deprecated:
Use
addResourceDependencyinstead.- Stability:
deprecated
- Return type:
None
- add_depends_on(target)
(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This method has been renamed to
addResourceDependency, which makes it more clear that this method operates at a different level from the construct-levelconstruct.node.addDependency()mechanism.- Parameters:
target (
CfnResource)- Deprecated:
Use
addResourceDependencyinstead.- Stability:
deprecated
- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str)value (
Any)
- See:
- Return type:
None
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverrideor prefixpathwith “Properties.” (i.e.Properties.TopicName).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.in the property name, prefix with a\. In most programming languages you will need to write this as"\\."because the\itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
valueargument toaddOverridewill not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters:
path (
str) –The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (
Any) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value).- Parameters:
property_path (
str) – The path of the property.value (
Any) – The value.
- Return type:
None
- add_resource_dependency(target, reason=None)
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use
construct.node.addDependencyinstead.- Parameters:
target (
CfnResource)reason (
Optional[str])
- Return type:
None
- apply_cross_stack_reference_strength(strength)
Sets the cross-stack reference strength for this resource.
When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack’s context.
- Parameters:
strength (
ReferenceStrength) –The reference strength to use for this resource.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:- Parameters:
policy (
Optional[RemovalPolicy])apply_to_update_replace_policy (
Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.
- See:
- Return type:
None
- cfn_property_name(cdk_property_name)
- Parameters:
cdk_property_name (
str)- Return type:
Optional[str]
- get_att(attribute_name, type_hint=None)
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn), but this can be used for future compatibility in case there is no generated attribute.- Parameters:
attribute_name (
str) – The name of the attribute.type_hint (
Optional[ResolutionTypeHint])
- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str)- See:
- Return type:
Any
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector) – tree inspector to collect and process attributes.- Return type:
None
- obtain_dependencies()
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
- Return type:
List[Union[CfnResource,Stack]]
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str) – The new logical ID to use for this stack element.- Return type:
None
- remove_dependency(target)
(deprecated) Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
- Parameters:
target (
CfnResource)- Deprecated:
Use
removeResourceDependencyinstead- Stability:
deprecated
- Return type:
None
- remove_resource_dependency(target)
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
- Parameters:
target (
CfnResource)- Return type:
None
- replace_dependency(target, new_target)
Replaces one dependency with another.
- Parameters:
target (
CfnResource) – The dependency to replace.new_target (
CfnResource) – The new dependency to add.
- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str- Returns:
a string representation of this resource
- with_(*mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple
with()calls if subsequent mixins should apply to added constructs.- Parameters:
mixins (
IMixin)- Return type:
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::QuickSight::Agent'
- action_connectors
A list of ActionConnector ARNs (max 10) attached to the agent.
- agent_id
The unique identifier for the agent.
- agent_lifecycle
The lifecycle stage of the agent.
- agent_ref
A reference to a Agent resource.
- attr_agent_status
The current status of the agent.
One of ACTIVE, CREATING, UPDATING, or FAILED.
- CloudformationAttribute:
AgentStatus
- attr_arn
The Amazon Resource Name (ARN) of the agent.
- CloudformationAttribute:
Arn
- attr_created_at
The date and time the agent was created.
- CloudformationAttribute:
CreatedAt
- attr_creator
The ARN of the user who created the agent.
- CloudformationAttribute:
Creator
- attr_custom_prompt_interface
Read-only view of the resolved custom prompt interface for the agent.
- CloudformationAttribute:
CustomPromptInterface
- attr_error_message
The error message if the agent is in FAILED status.
- CloudformationAttribute:
ErrorMessage
- attr_updated_at
The date and time the agent was last updated.
- CloudformationAttribute:
UpdatedAt
- aws_account_id
The ID of the Amazon Web Services account where the agent is being created.
- cdk_tag_manager
Tag Manager which manages the tags for this resource.
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- custom_prompt_input
Custom prompt configuration.
- description
A description of the agent.
- env
- icon_id
The icon identifier for the agent.
- logical_id
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId).- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- name
The display name of the agent.
- node
The tree node.
- ref
Return a string that will be resolved to a CloudFormation
{ Ref }for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref }).
- spaces
A list of Space ARNs (max 10) attached to the agent.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- starter_prompts
A list of up to 3 starter prompts displayed to users.
- tags
A list of key-value pairs to associate with the agent resource.
- welcome_message
The welcome message displayed when a user opens the agent.
Static Methods
- classmethod is_cfn_agent(x)
Checks whether the given object is a CfnAgent.
- Parameters:
x (
Any)- Return type:
bool
- classmethod is_cfn_element(x)
Returns
trueif a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceofto allow stack elements from different versions of this library to be included in the same stack.- Parameters:
x (
Any)- Return type:
bool- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_resource(x)
Check whether the given object is a CfnResource.
- Parameters:
x (
Any)- Return type:
bool
- classmethod is_construct(x)
Checks if
xis a construct.Use this method instead of
instanceofto properly detectConstructinstances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
constructslibrary on disk are seen as independent, completely different libraries. As a consequence, the classConstructin each copy of theconstructslibrary is seen as a different class, and an instance of one class will not test asinstanceofthe other class.npm installwill not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of theconstructslibrary can be accidentally installed, andinstanceofwill behave unpredictably. It is safest to avoid usinginstanceof, and using this type-testing method instead.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsConstruct.
AgentTagProperty
- class CfnAgent.AgentTagProperty(*, key, value)
Bases:
objectA key-value pair to associate with the agent resource.
- Parameters:
key (
str) – The key name of the tag.value (
str) – The value for the tag.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_quicksight as quicksight agent_tag_property = quicksight.CfnAgent.AgentTagProperty( key="key", value="value" )
Attributes
- key
The key name of the tag.
CustomPromptInputParametersProperty
- class CfnAgent.CustomPromptInputParametersProperty(*, custom_instructions=None, identity=None, output_style=None, response_length=None, tone=None)
Bases:
objectParameters for creating a new custom prompt configuration.
- Parameters:
custom_instructions (
Optional[str]) – Custom instructions for the agent behavior.identity (
Optional[str]) – The identity or persona of the agent.output_style (
Optional[str]) – The output style for the agent responses.response_length (
Optional[str]) – The desired response length for the agent.tone (
Optional[str]) – The tone used in agent responses.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_quicksight as quicksight custom_prompt_input_parameters_property = quicksight.CfnAgent.CustomPromptInputParametersProperty( custom_instructions="customInstructions", identity="identity", output_style="outputStyle", response_length="responseLength", tone="tone" )
Attributes
- custom_instructions
Custom instructions for the agent behavior.
- identity
The identity or persona of the agent.
- output_style
The output style for the agent responses.
- response_length
The desired response length for the agent.
CustomPromptInputProperty
- class CfnAgent.CustomPromptInputProperty(*, existing_prompt=None, new_prompt=None)
Bases:
objectCustom prompt configuration.
Specify either ExistingPrompt or NewPrompt.
- Parameters:
existing_prompt (
Union[IResolvable,CustomPromptProfileProperty,Dict[str,Any],None]) – Reference to an existing custom prompt profile.new_prompt (
Union[IResolvable,CustomPromptInputParametersProperty,Dict[str,Any],None]) – Parameters for creating a new custom prompt configuration.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_quicksight as quicksight custom_prompt_input_property = quicksight.CfnAgent.CustomPromptInputProperty( existing_prompt=quicksight.CfnAgent.CustomPromptProfileProperty( model_profile_id="modelProfileId", qbs_aws_account_id="qbsAwsAccountId", subscription_id="subscriptionId" ), new_prompt=quicksight.CfnAgent.CustomPromptInputParametersProperty( custom_instructions="customInstructions", identity="identity", output_style="outputStyle", response_length="responseLength", tone="tone" ) )
Attributes
- existing_prompt
Reference to an existing custom prompt profile.
- new_prompt
Parameters for creating a new custom prompt configuration.
CustomPromptInterfaceProperty
- class CfnAgent.CustomPromptInterfaceProperty(*, custom_instructions=None, identity=None, model_profile_id=None, output_style=None, prompt_summary=None, qbs_aws_account_id=None, response_length=None, subscription_id=None, tone=None)
Bases:
objectRead-only view of the resolved custom prompt interface for the agent.
- Parameters:
custom_instructions (
Optional[str]) – Custom instructions for the agent behavior.identity (
Optional[str]) – The identity or persona of the agent.model_profile_id (
Optional[str]) – The identifier of the model profile.output_style (
Optional[str]) – The output style for the agent responses.prompt_summary (
Optional[str]) – A summary of the resolved prompt.qbs_aws_account_id (
Optional[str]) – The QBS AWS account identifier.response_length (
Optional[str]) – The desired response length for the agent.subscription_id (
Optional[str]) – The subscription identifier.tone (
Optional[str]) – The tone used in agent responses.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_quicksight as quicksight custom_prompt_interface_property = quicksight.CfnAgent.CustomPromptInterfaceProperty( custom_instructions="customInstructions", identity="identity", model_profile_id="modelProfileId", output_style="outputStyle", prompt_summary="promptSummary", qbs_aws_account_id="qbsAwsAccountId", response_length="responseLength", subscription_id="subscriptionId", tone="tone" )
Attributes
- custom_instructions
Custom instructions for the agent behavior.
- identity
The identity or persona of the agent.
- model_profile_id
The identifier of the model profile.
- output_style
The output style for the agent responses.
- prompt_summary
A summary of the resolved prompt.
- qbs_aws_account_id
The QBS AWS account identifier.
- response_length
The desired response length for the agent.
- subscription_id
The subscription identifier.
- tone
The tone used in agent responses.
CustomPromptProfileProperty
- class CfnAgent.CustomPromptProfileProperty(*, model_profile_id, qbs_aws_account_id, subscription_id)
Bases:
objectReference to an existing custom prompt profile.
- Parameters:
model_profile_id (
str) – The identifier of the model profile.qbs_aws_account_id (
str) – The QBS AWS account identifier.subscription_id (
str) – The subscription identifier.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_quicksight as quicksight custom_prompt_profile_property = quicksight.CfnAgent.CustomPromptProfileProperty( model_profile_id="modelProfileId", qbs_aws_account_id="qbsAwsAccountId", subscription_id="subscriptionId" )
Attributes
- model_profile_id
The identifier of the model profile.
- qbs_aws_account_id
The QBS AWS account identifier.
- subscription_id
The subscription identifier.