AWS::SecurityHub::ProductSubscription
The AWS::SecurityHub::ProductSubscription
resource creates a subscription to a third-party product
that generates findings that you want to receive in AWS Security Hub. For a list of integrations to third-party
products, see Available third-party partner product integrations
in the
AWS Security Hub User Guide.
To change a product subscription, remove the current product subscription resource, and then create a new one.
Tags aren't supported for this resource.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::SecurityHub::ProductSubscription", "Properties" : { "ProductArn" :
String
} }
YAML
Type: AWS::SecurityHub::ProductSubscription Properties: ProductArn:
String
Properties
ProductArn
-
The ARN of the product to enable the integration for.
Required: Yes
Type: String
Pattern:
arn:aws\S*:securityhub:\S*
Update requires: Replacement
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref
returns the Amazon Resource Name (ARN) of your subscription to the product to enable integrations
for. For example, arn:aws:securityhub:us-east-1:123456789012:product-subscription/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
.
ProductSubscriptionArn
-
The ARN of your subscription to the product to enable integrations for.
Examples
Creating a Security Hub product subscription
The following example creates a Security Hub product subscription to the specified third-party product.
JSON
{ "Description": "Example template to create a Security Hub product subscription", "Resources": { "SecurityHubProductSubscription": { "Type": "AWS::SecurityHub::ProductSubscription", "Properties": { "ProductArn": { "Fn::Sub": "arn:${AWS::Partition}:securityhub:${AWS::Region}::product/aws/example" } } } } }
YAML
Description: Example template to create a Security Hub product subscription Resources: SecurityHubProductSubscription: Type: 'AWS::SecurityHub::ProductSubscription' Properties: ProductArn: !Sub 'arn:${AWS::Partition}:securityhub:${AWS::Region}::product/aws/example'