1. Packages
  2. AWS Native
  3. API Docs
  4. securityhub
  5. FindingAggregator

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi

aws-native.securityhub.FindingAggregator

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi

    The AWS::SecurityHub::FindingAggregator resource represents the AWS Security Hub Finding Aggregator in your account. One finding aggregator resource is created for each account in non opt-in region in which you configure region linking mode.

    Create FindingAggregator Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new FindingAggregator(name: string, args: FindingAggregatorArgs, opts?: CustomResourceOptions);
    @overload
    def FindingAggregator(resource_name: str,
                          args: FindingAggregatorArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def FindingAggregator(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          region_linking_mode: Optional[FindingAggregatorRegionLinkingMode] = None,
                          regions: Optional[Sequence[str]] = None)
    func NewFindingAggregator(ctx *Context, name string, args FindingAggregatorArgs, opts ...ResourceOption) (*FindingAggregator, error)
    public FindingAggregator(string name, FindingAggregatorArgs args, CustomResourceOptions? opts = null)
    public FindingAggregator(String name, FindingAggregatorArgs args)
    public FindingAggregator(String name, FindingAggregatorArgs args, CustomResourceOptions options)
    
    type: aws-native:securityhub:FindingAggregator
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args FindingAggregatorArgs
    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 FindingAggregatorArgs
    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 FindingAggregatorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FindingAggregatorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FindingAggregatorArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const findingAggregatorResource = new aws_native.securityhub.FindingAggregator("findingAggregatorResource", {
        regionLinkingMode: aws_native.securityhub.FindingAggregatorRegionLinkingMode.AllRegions,
        regions: ["string"],
    });
    
    Coming soon!
    

    FindingAggregator 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 FindingAggregator resource accepts the following input properties:

    RegionLinkingMode Pulumi.AwsNative.SecurityHub.FindingAggregatorRegionLinkingMode
    Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions
    Regions List<string>
    The list of excluded Regions or included Regions
    RegionLinkingMode FindingAggregatorRegionLinkingMode
    Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions
    Regions []string
    The list of excluded Regions or included Regions
    regionLinkingMode FindingAggregatorRegionLinkingMode
    Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions
    regions List<String>
    The list of excluded Regions or included Regions
    regionLinkingMode FindingAggregatorRegionLinkingMode
    Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions
    regions string[]
    The list of excluded Regions or included Regions
    region_linking_mode FindingAggregatorRegionLinkingMode
    Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions
    regions Sequence[str]
    The list of excluded Regions or included Regions
    regionLinkingMode "ALL_REGIONS" | "ALL_REGIONS_EXCEPT_SPECIFIED" | "SPECIFIED_REGIONS"
    Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions
    regions List<String>
    The list of excluded Regions or included Regions

    Outputs

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

    FindingAggregationRegion string
    The aggregation Region of the FindingAggregator
    FindingAggregatorArn string
    The ARN of the FindingAggregator being created and assigned as the unique identifier
    Id string
    The provider-assigned unique ID for this managed resource.
    FindingAggregationRegion string
    The aggregation Region of the FindingAggregator
    FindingAggregatorArn string
    The ARN of the FindingAggregator being created and assigned as the unique identifier
    Id string
    The provider-assigned unique ID for this managed resource.
    findingAggregationRegion String
    The aggregation Region of the FindingAggregator
    findingAggregatorArn String
    The ARN of the FindingAggregator being created and assigned as the unique identifier
    id String
    The provider-assigned unique ID for this managed resource.
    findingAggregationRegion string
    The aggregation Region of the FindingAggregator
    findingAggregatorArn string
    The ARN of the FindingAggregator being created and assigned as the unique identifier
    id string
    The provider-assigned unique ID for this managed resource.
    finding_aggregation_region str
    The aggregation Region of the FindingAggregator
    finding_aggregator_arn str
    The ARN of the FindingAggregator being created and assigned as the unique identifier
    id str
    The provider-assigned unique ID for this managed resource.
    findingAggregationRegion String
    The aggregation Region of the FindingAggregator
    findingAggregatorArn String
    The ARN of the FindingAggregator being created and assigned as the unique identifier
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    FindingAggregatorRegionLinkingMode, FindingAggregatorRegionLinkingModeArgs

    AllRegions
    ALL_REGIONS
    AllRegionsExceptSpecified
    ALL_REGIONS_EXCEPT_SPECIFIED
    SpecifiedRegions
    SPECIFIED_REGIONS
    FindingAggregatorRegionLinkingModeAllRegions
    ALL_REGIONS
    FindingAggregatorRegionLinkingModeAllRegionsExceptSpecified
    ALL_REGIONS_EXCEPT_SPECIFIED
    FindingAggregatorRegionLinkingModeSpecifiedRegions
    SPECIFIED_REGIONS
    AllRegions
    ALL_REGIONS
    AllRegionsExceptSpecified
    ALL_REGIONS_EXCEPT_SPECIFIED
    SpecifiedRegions
    SPECIFIED_REGIONS
    AllRegions
    ALL_REGIONS
    AllRegionsExceptSpecified
    ALL_REGIONS_EXCEPT_SPECIFIED
    SpecifiedRegions
    SPECIFIED_REGIONS
    ALL_REGIONS
    ALL_REGIONS
    ALL_REGIONS_EXCEPT_SPECIFIED
    ALL_REGIONS_EXCEPT_SPECIFIED
    SPECIFIED_REGIONS
    SPECIFIED_REGIONS
    "ALL_REGIONS"
    ALL_REGIONS
    "ALL_REGIONS_EXCEPT_SPECIFIED"
    ALL_REGIONS_EXCEPT_SPECIFIED
    "SPECIFIED_REGIONS"
    SPECIFIED_REGIONS

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi