AWS::SecurityAgent::AgentSpace - AWS CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::SecurityAgent::AgentSpace

The AWS::SecurityAgent::AgentSpace resource specifies an agent space for security testing. An agent space defines the scope of resources, integrations, and settings available to security testing operations.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::SecurityAgent::AgentSpace",
  "Properties" : {
      "AwsResources" : AWSResources,
      "CodeReviewSettings" : CodeReviewSettings,
      "Description" : String,
      "IntegratedResources" : [ IntegratedResource, ... ],
      "KmsKeyId" : String,
      "Name" : String,
      "Tags" : [ Tag, ... ],
      "TargetDomainIds" : [ String, ... ]
    }
}

YAML

Type: AWS::SecurityAgent::AgentSpace
Properties:
  AwsResources: 
    AWSResources
  CodeReviewSettings: 
    CodeReviewSettings
  Description: String
  IntegratedResources: 
    - IntegratedResource
  KmsKeyId: String
  Name: String
  Tags: 
    - Tag
  TargetDomainIds: 
    - String

Properties

AwsResources

The Amazon Web Services resources to associate with the agent space.

Required: No

Type: AWSResources

Update requires: No interruption

CodeReviewSettings

The code review settings for the agent space.

Required: No

Type: CodeReviewSettings

Update requires: No interruption

Description

A description of the agent space.

Required: No

Type: String

Update requires: No interruption

IntegratedResources

The list of integrated resource items to update.

Required: No

Type: Array of IntegratedResource

Update requires: No interruption

KmsKeyId

The identifier of the Amazon Web Services KMS key to use for encrypting data in the agent space.

Required: No

Type: String

Minimum: 1

Maximum: 2048

Update requires: Replacement

Name

The name of the agent space.

Required: Yes

Type: String

Update requires: No interruption

Tags

The tags to associate with the agent space.

Required: No

Type: Array of Tag

Update requires: No interruption

TargetDomainIds

The list of target domain identifiers to associate with the agent space.

Required: No

Type: Array of String

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the agent space ID. For example:

{ "Ref": "MyAgentSpace" }

For the agent space MyAgentSpace, Ref returns the unique identifier of the agent space.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

AgentSpaceId

The unique identifier of the agent space. For example: as-0123456789abcdef0.

CreatedAt

The date and time when the agent space was created, in ISO 8601 format. For example: 2024-01-01T00:00:00Z.

UpdatedAt

The date and time when the agent space was last updated, in ISO 8601 format. For example: 2024-01-01T00:00:00Z.