AWS::SecurityHub::ConnectorV2 - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

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

AWS::SecurityHub::ConnectorV2

Grants permission to create a connectorV2 based on input parameters.

Syntax

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

JSON

{
  "Type" : "AWS::SecurityHub::ConnectorV2",
  "Properties" : {
      "Description" : String,
      "KmsKeyArn" : String,
      "Name" : String,
      "Provider" : Provider,
      "Tags" : {Key: Value, ...}
    }
}

YAML

Type: AWS::SecurityHub::ConnectorV2
Properties:
  Description: String
  KmsKeyArn: String
  Name: String
  Provider: 
    Provider
  Tags: 
    Key: Value

Properties

Description

The description of the connectorV2.

Required: No

Type: String

Pattern: .*\S.*

Minimum: 0

Maximum: 256

Update requires: No interruption

KmsKeyArn

The Amazon Resource Name (ARN) of KMS key used to encrypt secrets for the connectorV2.

Required: No

Type: String

Pattern: .*\S.*

Minimum: 20

Maximum: 2048

Update requires: Replacement

Name

The unique name of the connectorV2.

Required: Yes

Type: String

Pattern: .*\S.*

Minimum: 1

Maximum: 64

Update requires: Replacement

Provider

The third-party provider detail for a service configuration.

Required: Yes

Type: Provider

Update requires: No interruption

Tags

The tags to add to the connectorV2 when you create.

Required: No

Type: Object of String

Pattern: ^(?!aws:)[a-zA-Z+-=._:/]{1,128}$

Minimum: 0

Maximum: 256

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ConnectorV2Arn for the ConnectorV2Arn resource created: arn:aws:securityhub:region:123456789012:connectorv2/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.

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.

ConnectorArn

The ARN of the V2 connector.

ConnectorId

The unique identifier of the V2 connector.

ConnectorStatus

The status of the V2 connector.

CreatedAt

The timestamp when the V2 connector was created.

LastCheckedAt

The most recent timestamp when the V2 connector was checked on health status.

LastUpdatedAt

The most recent timestamp when the V2 connector was updated.

Message

The message of the V2 connector when connector status is FAILED_TO_CONNECT.