Skip to content
v2.274.0

CfnAgentSpaceProps Struct ​

Properties for defining a CfnAgentSpace.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_devopsagent as devopsagent } from 'aws-cdk-lib';
const cfnAgentSpaceProps: devopsagent.CfnAgentSpaceProps = {
  name: 'name',

  // the properties below are optional
  description: 'description',
  kmsKeyArn: 'kmsKeyArn',
  locale: 'locale',
  operatorApp: {
    iam: {
      operatorAppRoleArn: 'operatorAppRoleArn',

      // the properties below are optional
      createdAt: 'createdAt',
      updatedAt: 'updatedAt',
    },
    idc: {
      idcInstanceArn: 'idcInstanceArn',
      operatorAppRoleArn: 'operatorAppRoleArn',

      // the properties below are optional
      createdAt: 'createdAt',
      idcApplicationArn: 'idcApplicationArn',
      updatedAt: 'updatedAt',
    },
    idp: {
      clientId: 'clientId',
      clientSecret: 'clientSecret',
      issuerUrl: 'issuerUrl',
      operatorAppRoleArn: 'operatorAppRoleArn',
      provider: 'provider',

      // the properties below are optional
      createdAt: 'createdAt',
      updatedAt: 'updatedAt',
      userIdClaim: 'userIdClaim',
    },
  },
  preferences: {
    elevatedActionsEnabled: false,
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
The description of the Agent Space.
kmsKeyArnoptionalstringkms_key_arnoptionalstrkmsKeyArnoptionalStringKmsKeyArnoptionalstringKmsKeyArnoptional*string#
The ARN of the KMS key to use for encryption.
localeoptionalstringlocaleoptionalstrlocaleoptionalStringLocaleoptionalstringLocaleoptional*string#
The locale for the AgentSpace, which determines the language used in agent responses.
namestringnamestrnameStringNamestringName*stringrequired#
The name of the Agent Space.
operatorAppoptionalIResolvable | CfnAgentSpace.OperatorAppPropertyoperator_appoptionaltyping.Union[IResolvable, OperatorAppProperty]operatorAppoptionalIResolvableOperatorAppoptionalIResolvableOperatorAppoptionalinterface{}#
preferencesoptionalIResolvable | CfnAgentSpace.PreferencesPropertypreferencesoptionaltyping.Union[IResolvable, PreferencesProperty]preferencesoptionalIResolvablePreferencesoptionalIResolvablePreferencesoptionalinterface{}#
Preferences that configure behavior of this AgentSpace.

This container fully owns the AgentSpace preferences: the properties supplied here replace the stored preferences in their entirety, and omitting the Preferences container reverts all preferences to their service defaults.

tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
An array of key-value pairs to apply to this resource.