AWS::SecurityAgent::TargetDomain - 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::TargetDomain

The AWS::SecurityAgent::TargetDomain resource specifies a target domain for security testing. A target domain represents a web domain that you own and want to include in penetration testing scope.

Syntax

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

JSON

{
  "Type" : "AWS::SecurityAgent::TargetDomain",
  "Properties" : {
      "Tags" : [ Tag, ... ],
      "TargetDomainName" : String,
      "VerificationMethod" : String
    }
}

YAML

Type: AWS::SecurityAgent::TargetDomain
Properties:
  Tags: 
    - Tag
  TargetDomainName: String
  VerificationMethod: String

Properties

Tags

The tags to associate with the target domain.

Required: No

Type: Array of Tag

Update requires: No interruption

TargetDomainName

The domain name to register as a target domain.

Required: Yes

Type: String

Update requires: Replacement

VerificationMethod

The method to use for verifying domain ownership. Valid values are DNS_TXT and HTTP_ROUTE.

Required: Yes

Type: String

Allowed values: DNS_TXT | HTTP_ROUTE

Update requires: No interruption

Return values

Ref

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

{ "Ref": "MyTargetDomain" }

For the target domain MyTargetDomain, Ref returns the unique identifier of the target domain.

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.

CreatedAt

The date and time when the target domain was registered, in ISO 8601 format. For example: 2024-01-01T00:00:00Z.

TargetDomainId

The unique identifier of the target domain. For example: td-0123456789abcdef0.

VerificationStatus

The current verification status of the target domain. Valid values are PENDING, VERIFIED, FAILED, and UNREACHABLE.

VerifiedAt

The date and time when the target domain was last successfully verified, in ISO 8601 format. For example: 2024-01-01T00:00:00Z.