Skip to content
v2.277.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',
  }],
};
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_devopsagent as devopsagent

cfn_agent_space_props = devopsagent.CfnAgentSpaceProps(
    name="name",

    # the properties below are optional
    description="description",
    kms_key_arn="kmsKeyArn",
    locale="locale",
    operator_app=devopsagent.CfnAgentSpace.OperatorAppProperty(
        iam=devopsagent.CfnAgentSpace.IamAuthConfigurationProperty(
            operator_app_role_arn="operatorAppRoleArn",

            # the properties below are optional
            created_at="createdAt",
            updated_at="updatedAt"
        ),
        idc=devopsagent.CfnAgentSpace.IdcAuthConfigurationProperty(
            idc_instance_arn="idcInstanceArn",
            operator_app_role_arn="operatorAppRoleArn",

            # the properties below are optional
            created_at="createdAt",
            idc_application_arn="idcApplicationArn",
            updated_at="updatedAt"
        ),
        idp=devopsagent.CfnAgentSpace.IdpAuthConfigurationProperty(
            client_id="clientId",
            client_secret="clientSecret",
            issuer_url="issuerUrl",
            operator_app_role_arn="operatorAppRoleArn",
            provider="provider",

            # the properties below are optional
            created_at="createdAt",
            updated_at="updatedAt",
            user_id_claim="userIdClaim"
        )
    ),
    preferences=devopsagent.CfnAgentSpace.PreferencesProperty(
        elevated_actions_enabled=False
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.devopsagent.*;

CfnAgentSpaceProps cfnAgentSpaceProps = CfnAgentSpaceProps.builder()
        .name("name")

        // the properties below are optional
        .description("description")
        .kmsKeyArn("kmsKeyArn")
        .locale("locale")
        .operatorApp(OperatorAppProperty.builder()
                .iam(IamAuthConfigurationProperty.builder()
                        .operatorAppRoleArn("operatorAppRoleArn")

                        // the properties below are optional
                        .createdAt("createdAt")
                        .updatedAt("updatedAt")
                        .build())
                .idc(IdcAuthConfigurationProperty.builder()
                        .idcInstanceArn("idcInstanceArn")
                        .operatorAppRoleArn("operatorAppRoleArn")

                        // the properties below are optional
                        .createdAt("createdAt")
                        .idcApplicationArn("idcApplicationArn")
                        .updatedAt("updatedAt")
                        .build())
                .idp(IdpAuthConfigurationProperty.builder()
                        .clientId("clientId")
                        .clientSecret("clientSecret")
                        .issuerUrl("issuerUrl")
                        .operatorAppRoleArn("operatorAppRoleArn")
                        .provider("provider")

                        // the properties below are optional
                        .createdAt("createdAt")
                        .updatedAt("updatedAt")
                        .userIdClaim("userIdClaim")
                        .build())
                .build())
        .preferences(PreferencesProperty.builder()
                .elevatedActionsEnabled(false)
                .build())
        .tags(List.of(CfnTag.builder()
                .key("key")
                .value("value")
                .build()))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.DevOpsAgent;

var cfnAgentSpaceProps = new CfnAgentSpaceProps {
    Name = "name",

    // the properties below are optional
    Description = "description",
    KmsKeyArn = "kmsKeyArn",
    Locale = "locale",
    OperatorApp = new OperatorAppProperty {
        Iam = new IamAuthConfigurationProperty {
            OperatorAppRoleArn = "operatorAppRoleArn",

            // the properties below are optional
            CreatedAt = "createdAt",
            UpdatedAt = "updatedAt"
        },
        Idc = new IdcAuthConfigurationProperty {
            IdcInstanceArn = "idcInstanceArn",
            OperatorAppRoleArn = "operatorAppRoleArn",

            // the properties below are optional
            CreatedAt = "createdAt",
            IdcApplicationArn = "idcApplicationArn",
            UpdatedAt = "updatedAt"
        },
        Idp = new IdpAuthConfigurationProperty {
            ClientId = "clientId",
            ClientSecret = "clientSecret",
            IssuerUrl = "issuerUrl",
            OperatorAppRoleArn = "operatorAppRoleArn",
            Provider = "provider",

            // the properties below are optional
            CreatedAt = "createdAt",
            UpdatedAt = "updatedAt",
            UserIdClaim = "userIdClaim"
        }
    },
    Preferences = new PreferencesProperty {
        ElevatedActionsEnabled = false
    },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnAgentSpaceProps := &CfnAgentSpaceProps{
	Name: jsii.String("name"),

	// the properties below are optional
	Description: jsii.String("description"),
	KmsKeyArn: jsii.String("kmsKeyArn"),
	Locale: jsii.String("locale"),
	OperatorApp: &OperatorAppProperty{
		Iam: &IamAuthConfigurationProperty{
			OperatorAppRoleArn: jsii.String("operatorAppRoleArn"),

			// the properties below are optional
			CreatedAt: jsii.String("createdAt"),
			UpdatedAt: jsii.String("updatedAt"),
		},
		Idc: &IdcAuthConfigurationProperty{
			IdcInstanceArn: jsii.String("idcInstanceArn"),
			OperatorAppRoleArn: jsii.String("operatorAppRoleArn"),

			// the properties below are optional
			CreatedAt: jsii.String("createdAt"),
			IdcApplicationArn: jsii.String("idcApplicationArn"),
			UpdatedAt: jsii.String("updatedAt"),
		},
		Idp: &IdpAuthConfigurationProperty{
			ClientId: jsii.String("clientId"),
			ClientSecret: jsii.String("clientSecret"),
			IssuerUrl: jsii.String("issuerUrl"),
			OperatorAppRoleArn: jsii.String("operatorAppRoleArn"),
			Provider: jsii.String("provider"),

			// the properties below are optional
			CreatedAt: jsii.String("createdAt"),
			UpdatedAt: jsii.String("updatedAt"),
			UserIdClaim: jsii.String("userIdClaim"),
		},
	},
	Preferences: &PreferencesProperty{
		ElevatedActionsEnabled: jsii.Boolean(false),
	},
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("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*string required #
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.