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_securityagent as securityagent } from 'aws-cdk-lib';
const cfnAgentSpaceProps: securityagent.CfnAgentSpaceProps = {
  name: 'name',

  // the properties below are optional
  awsResources: {
    iamRoles: ['iamRoles'],
    lambdaFunctionArns: ['lambdaFunctionArns'],
    logGroups: ['logGroups'],
    s3Buckets: ['s3Buckets'],
    secretArns: ['secretArns'],
    vpcs: [{
      securityGroupArns: ['securityGroupArns'],
      subnetArns: ['subnetArns'],
      vpcArn: 'vpcArn',
    }],
  },
  codeReviewSettings: {
    controlsScanning: false,
    generalPurposeScanning: false,
  },
  description: 'description',
  integratedResources: [{
    integration: 'integration',
  }],
  kmsKeyId: 'kmsKeyId',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  targetDomainIds: ['targetDomainIds'],
};
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_securityagent as securityagent

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

    # the properties below are optional
    aws_resources=securityagent.CfnAgentSpace.AWSResourcesProperty(
        iam_roles=["iamRoles"],
        lambda_function_arns=["lambdaFunctionArns"],
        log_groups=["logGroups"],
        s3_buckets=["s3Buckets"],
        secret_arns=["secretArns"],
        vpcs=[securityagent.CfnAgentSpace.VpcConfigProperty(
            security_group_arns=["securityGroupArns"],
            subnet_arns=["subnetArns"],
            vpc_arn="vpcArn"
        )]
    ),
    code_review_settings=securityagent.CfnAgentSpace.CodeReviewSettingsProperty(
        controls_scanning=False,
        general_purpose_scanning=False
    ),
    description="description",
    integrated_resources=[securityagent.CfnAgentSpace.IntegratedResourceProperty(
        integration="integration"
    )],
    kms_key_id="kmsKeyId",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    target_domain_ids=["targetDomainIds"]
)
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.securityagent.*;

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

        // the properties below are optional
        .awsResources(AWSResourcesProperty.builder()
                .iamRoles(List.of("iamRoles"))
                .lambdaFunctionArns(List.of("lambdaFunctionArns"))
                .logGroups(List.of("logGroups"))
                .s3Buckets(List.of("s3Buckets"))
                .secretArns(List.of("secretArns"))
                .vpcs(List.of(VpcConfigProperty.builder()
                        .securityGroupArns(List.of("securityGroupArns"))
                        .subnetArns(List.of("subnetArns"))
                        .vpcArn("vpcArn")
                        .build()))
                .build())
        .codeReviewSettings(CodeReviewSettingsProperty.builder()
                .controlsScanning(false)
                .generalPurposeScanning(false)
                .build())
        .description("description")
        .integratedResources(List.of(IntegratedResourceProperty.builder()
                .integration("integration")
                .build()))
        .kmsKeyId("kmsKeyId")
        .tags(List.of(CfnTag.builder()
                .key("key")
                .value("value")
                .build()))
        .targetDomainIds(List.of("targetDomainIds"))
        .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.SecurityAgent;

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

    // the properties below are optional
    AwsResources = new AWSResourcesProperty {
        IamRoles = new [] { "iamRoles" },
        LambdaFunctionArns = new [] { "lambdaFunctionArns" },
        LogGroups = new [] { "logGroups" },
        S3Buckets = new [] { "s3Buckets" },
        SecretArns = new [] { "secretArns" },
        Vpcs = new [] { new VpcConfigProperty {
            SecurityGroupArns = new [] { "securityGroupArns" },
            SubnetArns = new [] { "subnetArns" },
            VpcArn = "vpcArn"
        } }
    },
    CodeReviewSettings = new CodeReviewSettingsProperty {
        ControlsScanning = false,
        GeneralPurposeScanning = false
    },
    Description = "description",
    IntegratedResources = new [] { new IntegratedResourceProperty {
        Integration = "integration"
    } },
    KmsKeyId = "kmsKeyId",
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    TargetDomainIds = new [] { "targetDomainIds" }
};
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
	AwsResources: &AWSResourcesProperty{
		IamRoles: []*string{
			jsii.String("iamRoles"),
		},
		LambdaFunctionArns: []*string{
			jsii.String("lambdaFunctionArns"),
		},
		LogGroups: []*string{
			jsii.String("logGroups"),
		},
		S3Buckets: []*string{
			jsii.String("s3Buckets"),
		},
		SecretArns: []*string{
			jsii.String("secretArns"),
		},
		Vpcs: []interface{}{
			&VpcConfigProperty{
				SecurityGroupArns: []*string{
					jsii.String("securityGroupArns"),
				},
				SubnetArns: []*string{
					jsii.String("subnetArns"),
				},
				VpcArn: jsii.String("vpcArn"),
			},
		},
	},
	CodeReviewSettings: &CodeReviewSettingsProperty{
		ControlsScanning: jsii.Boolean(false),
		GeneralPurposeScanning: jsii.Boolean(false),
	},
	Description: jsii.String("description"),
	IntegratedResources: []interface{}{
		&IntegratedResourceProperty{
			Integration: jsii.String("integration"),
		},
	},
	KmsKeyId: jsii.String("kmsKeyId"),
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
	TargetDomainIds: []*string{
		jsii.String("targetDomainIds"),
	},
}

Properties ​

awsResourcesoptionalIResolvable | CfnAgentSpace.AWSResourcesPropertyaws_resourcesoptionaltyping.Union[IResolvable, AWSResourcesProperty]awsResourcesoptionalIResolvableAwsResourcesoptionalIResolvableAwsResourcesoptionalinterface{}#
AWS resource configuration.
codeReviewSettingsoptionalIResolvable | CfnAgentSpace.CodeReviewSettingsPropertycode_review_settingsoptionaltyping.Union[IResolvable, CodeReviewSettingsProperty]codeReviewSettingsoptionalIResolvableCodeReviewSettingsoptionalIResolvableCodeReviewSettingsoptionalinterface{}#
Details of code review settings.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
Description of the agent space.
integratedResourcesoptionalIResolvable | IResolvable | CfnAgentSpace.IntegratedResourceProperty[]integrated_resourcesoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, IntegratedResourceProperty]]]integratedResourcesoptionalIResolvableIntegratedResourcesoptionalIResolvableIntegratedResourcesoptionalinterface{}#
Integrated Resources configuration.
kmsKeyIdoptionalstringkms_key_idoptionalstrkmsKeyIdoptionalStringKmsKeyIdoptionalstringKmsKeyIdoptional*string#
Identifier of the KMS key used to encrypt data.

Can be a key ID, key ARN, alias name, or alias ARN. If not specified, an AWS managed key is used.

namestringnamestrnameStringNamestringName*stringrequired#
Name of the agent space.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
Tags for the agent space.
targetDomainIdsoptionalstring[]target_domain_idsoptionaltyping.List[str]targetDomainIdsoptionalList<String>TargetDomainIdsoptionalstring[]TargetDomainIdsoptional*[]*string#
List of target domain identifiers registered with the agent space.