aws-cdk-lib.aws_connect.CfnAgentStatusProps

CfnAgentStatusProps Struct

Properties for defining a CfnAgentStatus.

CfnAgentStatusProps

used as props by

• CfnAgentStatus

Source

Generated code

Type last changed

v2.159.0 · 19 Sep 2024

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_connect as connect } from 'aws-cdk-lib';
const cfnAgentStatusProps: connect.CfnAgentStatusProps = {
  instanceArn: 'instanceArn',
  name: 'name',
  state: 'state',

  // the properties below are optional
  description: 'description',
  displayOrder: 123,
  resetOrderNumber: false,
  tags: [{
    key: 'key',
    value: 'value',
  }],
  type: 'type',
};

Properties

descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string#

The description of the agent status.

displayOrdernumberdisplay_orderint | floatdisplayOrderNumberDisplayOrderdoubleDisplayOrder*float64#

The display order of the agent status.

instanceArnstringinstance_arnstrinstanceArnStringInstanceArnstringInstanceArn*stringrequired#

The Amazon Resource Name (ARN) of the instance.

namestringnamestrnameStringNamestringName*stringrequired#

The name of the agent status.

resetOrderNumberboolean | IResolvablereset_order_numbertyping.Union[bool, IResolvable]resetOrderNumberBooleanResetOrderNumberboolResetOrderNumberinterface{}#

A number indicating the reset order of the agent status.

statestringstatestrstateStringStatestringState*stringrequired#

The state of the agent status.

tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#

The tags used to organize, track, or control access for this resource.

For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

typestringtypestrtypeStringTypestringType*string#

The type of agent status.