1. Packages
  2. AWS Classic
  3. API Docs
  4. securityhub
  5. StandardsSubscription

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.27.0 published on Monday, Mar 18, 2024 by Pulumi

aws.securityhub.StandardsSubscription

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.27.0 published on Monday, Mar 18, 2024 by Pulumi

    Subscribes to a Security Hub standard.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.securityhub.Account("example", {});
    const current = aws.getRegion({});
    const cis = new aws.securityhub.StandardsSubscription("cis", {standardsArn: "arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0"});
    const pci321 = new aws.securityhub.StandardsSubscription("pci_321", {standardsArn: current.then(current => `arn:aws:securityhub:${current.name}::standards/pci-dss/v/3.2.1`)});
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.securityhub.Account("example")
    current = aws.get_region()
    cis = aws.securityhub.StandardsSubscription("cis", standards_arn="arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0")
    pci321 = aws.securityhub.StandardsSubscription("pci_321", standards_arn=f"arn:aws:securityhub:{current.name}::standards/pci-dss/v/3.2.1")
    
    package main
    
    import (
    	"fmt"
    
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws"
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/securityhub"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := securityhub.NewAccount(ctx, "example", nil)
    		if err != nil {
    			return err
    		}
    		current, err := aws.GetRegion(ctx, nil, nil)
    		if err != nil {
    			return err
    		}
    		_, err = securityhub.NewStandardsSubscription(ctx, "cis", &securityhub.StandardsSubscriptionArgs{
    			StandardsArn: pulumi.String("arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = securityhub.NewStandardsSubscription(ctx, "pci_321", &securityhub.StandardsSubscriptionArgs{
    			StandardsArn: pulumi.String(fmt.Sprintf("arn:aws:securityhub:%v::standards/pci-dss/v/3.2.1", current.Name)),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.SecurityHub.Account("example");
    
        var current = Aws.GetRegion.Invoke();
    
        var cis = new Aws.SecurityHub.StandardsSubscription("cis", new()
        {
            StandardsArn = "arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0",
        });
    
        var pci321 = new Aws.SecurityHub.StandardsSubscription("pci_321", new()
        {
            StandardsArn = $"arn:aws:securityhub:{current.Apply(getRegionResult => getRegionResult.Name)}::standards/pci-dss/v/3.2.1",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.securityhub.Account;
    import com.pulumi.aws.AwsFunctions;
    import com.pulumi.aws.inputs.GetRegionArgs;
    import com.pulumi.aws.securityhub.StandardsSubscription;
    import com.pulumi.aws.securityhub.StandardsSubscriptionArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new Account("example");
    
            final var current = AwsFunctions.getRegion();
    
            var cis = new StandardsSubscription("cis", StandardsSubscriptionArgs.builder()        
                .standardsArn("arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0")
                .build());
    
            var pci321 = new StandardsSubscription("pci321", StandardsSubscriptionArgs.builder()        
                .standardsArn(String.format("arn:aws:securityhub:%s::standards/pci-dss/v/3.2.1", current.applyValue(getRegionResult -> getRegionResult.name())))
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:securityhub:Account
      cis:
        type: aws:securityhub:StandardsSubscription
        properties:
          standardsArn: arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0
      pci321:
        type: aws:securityhub:StandardsSubscription
        name: pci_321
        properties:
          standardsArn: arn:aws:securityhub:${current.name}::standards/pci-dss/v/3.2.1
    variables:
      current:
        fn::invoke:
          Function: aws:getRegion
          Arguments: {}
    

    Create StandardsSubscription Resource

    new StandardsSubscription(name: string, args: StandardsSubscriptionArgs, opts?: CustomResourceOptions);
    @overload
    def StandardsSubscription(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              standards_arn: Optional[str] = None)
    @overload
    def StandardsSubscription(resource_name: str,
                              args: StandardsSubscriptionArgs,
                              opts: Optional[ResourceOptions] = None)
    func NewStandardsSubscription(ctx *Context, name string, args StandardsSubscriptionArgs, opts ...ResourceOption) (*StandardsSubscription, error)
    public StandardsSubscription(string name, StandardsSubscriptionArgs args, CustomResourceOptions? opts = null)
    public StandardsSubscription(String name, StandardsSubscriptionArgs args)
    public StandardsSubscription(String name, StandardsSubscriptionArgs args, CustomResourceOptions options)
    
    type: aws:securityhub:StandardsSubscription
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args StandardsSubscriptionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args StandardsSubscriptionArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args StandardsSubscriptionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args StandardsSubscriptionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args StandardsSubscriptionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    StandardsSubscription Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The StandardsSubscription resource accepts the following input properties:

    StandardsArn string

    The ARN of a standard - see below.

    Currently available standards (remember to replace ${var.region} as appropriate):

    | Name | ARN | |------------------------------------------|-------------------------------------------------------------------------------------------------| | AWS Foundational Security Best Practices | arn:aws:securityhub:${var.region}::standards/aws-foundational-security-best-practices/v/1.0.0 | | CIS AWS Foundations Benchmark v1.2.0 | arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0 | | CIS AWS Foundations Benchmark v1.4.0 | arn:aws:securityhub:${var.region}::standards/cis-aws-foundations-benchmark/v/1.4.0 | | NIST SP 800-53 Rev. 5 | arn:aws:securityhub:${var.region}::standards/nist-800-53/v/5.0.0 | | PCI DSS | arn:aws:securityhub:${var.region}::standards/pci-dss/v/3.2.1 |

    StandardsArn string

    The ARN of a standard - see below.

    Currently available standards (remember to replace ${var.region} as appropriate):

    | Name | ARN | |------------------------------------------|-------------------------------------------------------------------------------------------------| | AWS Foundational Security Best Practices | arn:aws:securityhub:${var.region}::standards/aws-foundational-security-best-practices/v/1.0.0 | | CIS AWS Foundations Benchmark v1.2.0 | arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0 | | CIS AWS Foundations Benchmark v1.4.0 | arn:aws:securityhub:${var.region}::standards/cis-aws-foundations-benchmark/v/1.4.0 | | NIST SP 800-53 Rev. 5 | arn:aws:securityhub:${var.region}::standards/nist-800-53/v/5.0.0 | | PCI DSS | arn:aws:securityhub:${var.region}::standards/pci-dss/v/3.2.1 |

    standardsArn String

    The ARN of a standard - see below.

    Currently available standards (remember to replace ${var.region} as appropriate):

    | Name | ARN | |------------------------------------------|-------------------------------------------------------------------------------------------------| | AWS Foundational Security Best Practices | arn:aws:securityhub:${var.region}::standards/aws-foundational-security-best-practices/v/1.0.0 | | CIS AWS Foundations Benchmark v1.2.0 | arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0 | | CIS AWS Foundations Benchmark v1.4.0 | arn:aws:securityhub:${var.region}::standards/cis-aws-foundations-benchmark/v/1.4.0 | | NIST SP 800-53 Rev. 5 | arn:aws:securityhub:${var.region}::standards/nist-800-53/v/5.0.0 | | PCI DSS | arn:aws:securityhub:${var.region}::standards/pci-dss/v/3.2.1 |

    standardsArn string

    The ARN of a standard - see below.

    Currently available standards (remember to replace ${var.region} as appropriate):

    | Name | ARN | |------------------------------------------|-------------------------------------------------------------------------------------------------| | AWS Foundational Security Best Practices | arn:aws:securityhub:${var.region}::standards/aws-foundational-security-best-practices/v/1.0.0 | | CIS AWS Foundations Benchmark v1.2.0 | arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0 | | CIS AWS Foundations Benchmark v1.4.0 | arn:aws:securityhub:${var.region}::standards/cis-aws-foundations-benchmark/v/1.4.0 | | NIST SP 800-53 Rev. 5 | arn:aws:securityhub:${var.region}::standards/nist-800-53/v/5.0.0 | | PCI DSS | arn:aws:securityhub:${var.region}::standards/pci-dss/v/3.2.1 |

    standards_arn str

    The ARN of a standard - see below.

    Currently available standards (remember to replace ${var.region} as appropriate):

    | Name | ARN | |------------------------------------------|-------------------------------------------------------------------------------------------------| | AWS Foundational Security Best Practices | arn:aws:securityhub:${var.region}::standards/aws-foundational-security-best-practices/v/1.0.0 | | CIS AWS Foundations Benchmark v1.2.0 | arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0 | | CIS AWS Foundations Benchmark v1.4.0 | arn:aws:securityhub:${var.region}::standards/cis-aws-foundations-benchmark/v/1.4.0 | | NIST SP 800-53 Rev. 5 | arn:aws:securityhub:${var.region}::standards/nist-800-53/v/5.0.0 | | PCI DSS | arn:aws:securityhub:${var.region}::standards/pci-dss/v/3.2.1 |

    standardsArn String

    The ARN of a standard - see below.

    Currently available standards (remember to replace ${var.region} as appropriate):

    | Name | ARN | |------------------------------------------|-------------------------------------------------------------------------------------------------| | AWS Foundational Security Best Practices | arn:aws:securityhub:${var.region}::standards/aws-foundational-security-best-practices/v/1.0.0 | | CIS AWS Foundations Benchmark v1.2.0 | arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0 | | CIS AWS Foundations Benchmark v1.4.0 | arn:aws:securityhub:${var.region}::standards/cis-aws-foundations-benchmark/v/1.4.0 | | NIST SP 800-53 Rev. 5 | arn:aws:securityhub:${var.region}::standards/nist-800-53/v/5.0.0 | | PCI DSS | arn:aws:securityhub:${var.region}::standards/pci-dss/v/3.2.1 |

    Outputs

    All input properties are implicitly available as output properties. Additionally, the StandardsSubscription resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing StandardsSubscription Resource

    Get an existing StandardsSubscription resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: StandardsSubscriptionState, opts?: CustomResourceOptions): StandardsSubscription
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            standards_arn: Optional[str] = None) -> StandardsSubscription
    func GetStandardsSubscription(ctx *Context, name string, id IDInput, state *StandardsSubscriptionState, opts ...ResourceOption) (*StandardsSubscription, error)
    public static StandardsSubscription Get(string name, Input<string> id, StandardsSubscriptionState? state, CustomResourceOptions? opts = null)
    public static StandardsSubscription get(String name, Output<String> id, StandardsSubscriptionState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    StandardsArn string

    The ARN of a standard - see below.

    Currently available standards (remember to replace ${var.region} as appropriate):

    | Name | ARN | |------------------------------------------|-------------------------------------------------------------------------------------------------| | AWS Foundational Security Best Practices | arn:aws:securityhub:${var.region}::standards/aws-foundational-security-best-practices/v/1.0.0 | | CIS AWS Foundations Benchmark v1.2.0 | arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0 | | CIS AWS Foundations Benchmark v1.4.0 | arn:aws:securityhub:${var.region}::standards/cis-aws-foundations-benchmark/v/1.4.0 | | NIST SP 800-53 Rev. 5 | arn:aws:securityhub:${var.region}::standards/nist-800-53/v/5.0.0 | | PCI DSS | arn:aws:securityhub:${var.region}::standards/pci-dss/v/3.2.1 |

    StandardsArn string

    The ARN of a standard - see below.

    Currently available standards (remember to replace ${var.region} as appropriate):

    | Name | ARN | |------------------------------------------|-------------------------------------------------------------------------------------------------| | AWS Foundational Security Best Practices | arn:aws:securityhub:${var.region}::standards/aws-foundational-security-best-practices/v/1.0.0 | | CIS AWS Foundations Benchmark v1.2.0 | arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0 | | CIS AWS Foundations Benchmark v1.4.0 | arn:aws:securityhub:${var.region}::standards/cis-aws-foundations-benchmark/v/1.4.0 | | NIST SP 800-53 Rev. 5 | arn:aws:securityhub:${var.region}::standards/nist-800-53/v/5.0.0 | | PCI DSS | arn:aws:securityhub:${var.region}::standards/pci-dss/v/3.2.1 |

    standardsArn String

    The ARN of a standard - see below.

    Currently available standards (remember to replace ${var.region} as appropriate):

    | Name | ARN | |------------------------------------------|-------------------------------------------------------------------------------------------------| | AWS Foundational Security Best Practices | arn:aws:securityhub:${var.region}::standards/aws-foundational-security-best-practices/v/1.0.0 | | CIS AWS Foundations Benchmark v1.2.0 | arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0 | | CIS AWS Foundations Benchmark v1.4.0 | arn:aws:securityhub:${var.region}::standards/cis-aws-foundations-benchmark/v/1.4.0 | | NIST SP 800-53 Rev. 5 | arn:aws:securityhub:${var.region}::standards/nist-800-53/v/5.0.0 | | PCI DSS | arn:aws:securityhub:${var.region}::standards/pci-dss/v/3.2.1 |

    standardsArn string

    The ARN of a standard - see below.

    Currently available standards (remember to replace ${var.region} as appropriate):

    | Name | ARN | |------------------------------------------|-------------------------------------------------------------------------------------------------| | AWS Foundational Security Best Practices | arn:aws:securityhub:${var.region}::standards/aws-foundational-security-best-practices/v/1.0.0 | | CIS AWS Foundations Benchmark v1.2.0 | arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0 | | CIS AWS Foundations Benchmark v1.4.0 | arn:aws:securityhub:${var.region}::standards/cis-aws-foundations-benchmark/v/1.4.0 | | NIST SP 800-53 Rev. 5 | arn:aws:securityhub:${var.region}::standards/nist-800-53/v/5.0.0 | | PCI DSS | arn:aws:securityhub:${var.region}::standards/pci-dss/v/3.2.1 |

    standards_arn str

    The ARN of a standard - see below.

    Currently available standards (remember to replace ${var.region} as appropriate):

    | Name | ARN | |------------------------------------------|-------------------------------------------------------------------------------------------------| | AWS Foundational Security Best Practices | arn:aws:securityhub:${var.region}::standards/aws-foundational-security-best-practices/v/1.0.0 | | CIS AWS Foundations Benchmark v1.2.0 | arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0 | | CIS AWS Foundations Benchmark v1.4.0 | arn:aws:securityhub:${var.region}::standards/cis-aws-foundations-benchmark/v/1.4.0 | | NIST SP 800-53 Rev. 5 | arn:aws:securityhub:${var.region}::standards/nist-800-53/v/5.0.0 | | PCI DSS | arn:aws:securityhub:${var.region}::standards/pci-dss/v/3.2.1 |

    standardsArn String

    The ARN of a standard - see below.

    Currently available standards (remember to replace ${var.region} as appropriate):

    | Name | ARN | |------------------------------------------|-------------------------------------------------------------------------------------------------| | AWS Foundational Security Best Practices | arn:aws:securityhub:${var.region}::standards/aws-foundational-security-best-practices/v/1.0.0 | | CIS AWS Foundations Benchmark v1.2.0 | arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0 | | CIS AWS Foundations Benchmark v1.4.0 | arn:aws:securityhub:${var.region}::standards/cis-aws-foundations-benchmark/v/1.4.0 | | NIST SP 800-53 Rev. 5 | arn:aws:securityhub:${var.region}::standards/nist-800-53/v/5.0.0 | | PCI DSS | arn:aws:securityhub:${var.region}::standards/pci-dss/v/3.2.1 |

    Import

    Using pulumi import, import Security Hub standards subscriptions using the standards subscription ARN. For example:

    $ pulumi import aws:securityhub/standardsSubscription:StandardsSubscription cis arn:aws:securityhub:eu-west-1:123456789012:subscription/cis-aws-foundations-benchmark/v/1.2.0
    
    $ pulumi import aws:securityhub/standardsSubscription:StandardsSubscription pci_321 arn:aws:securityhub:eu-west-1:123456789012:subscription/pci-dss/v/3.2.1
    
    $ pulumi import aws:securityhub/standardsSubscription:StandardsSubscription nist_800_53_rev_5 arn:aws:securityhub:eu-west-1:123456789012:subscription/nist-800-53/v/5.0.0
    

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.27.0 published on Monday, Mar 18, 2024 by Pulumi