Package-level declarations

Types

Link copied to clipboard
class AutomationRule : KotlinCustomResource

The `AWS::SecurityHub::AutomationRule` resource specifies an automation rule based on input parameters. For more information, see Automation rules in the User Guide.

Link copied to clipboard
data class AutomationRuleArgs(val actions: Output<List<AutomationRulesActionArgs>>? = null, val criteria: Output<AutomationRulesFindingFiltersArgs>? = null, val description: Output<String>? = null, val isTerminal: Output<Boolean>? = null, val ruleName: Output<String>? = null, val ruleOrder: Output<Int>? = null, val ruleStatus: Output<AutomationRuleRuleStatus>? = null, val tags: Output<Map<String, String>>? = null) : ConvertibleToJava<AutomationRuleArgs>

The `AWS::SecurityHub::AutomationRule` resource specifies an automation rule based on input parameters. For more information, see Automation rules in the User Guide.

Link copied to clipboard
Link copied to clipboard
object AutomationRuleMapper : ResourceMapper<AutomationRule>
Link copied to clipboard
class ConfigurationPolicy : KotlinCustomResource

The AWS::SecurityHub::ConfigurationPolicy resource represents the Central Configuration Policy in your account.

Link copied to clipboard
data class ConfigurationPolicyArgs(val configurationPolicy: Output<ConfigurationPolicyPolicyArgs>? = null, val description: Output<String>? = null, val name: Output<String>? = null, val tags: Output<Map<String, String>>? = null) : ConvertibleToJava<ConfigurationPolicyArgs>

The AWS::SecurityHub::ConfigurationPolicy resource represents the Central Configuration Policy in your account.

Link copied to clipboard
Link copied to clipboard
class DelegatedAdmin : KotlinCustomResource

The `AWS::SecurityHub::DelegatedAdmin` resource designates the delegated ASHlong administrator account for an organization. You must enable the integration between ASH and AOlong before you can designate a delegated ASH administrator. Only the management account for an organization can designate the delegated ASH administrator account. For more information, see Designating the delegated administrator in the User Guide. To change the delegated administrator account, remove the current delegated administrator account, and then designate the new account. To designate multiple delegated administrators in different organizations and AWS-Regions, we recommend using mappings. Tags aren't supported for this resource.

Link copied to clipboard
data class DelegatedAdminArgs(val adminAccountId: Output<String>? = null) : ConvertibleToJava<DelegatedAdminArgs>

The `AWS::SecurityHub::DelegatedAdmin` resource designates the delegated ASHlong administrator account for an organization. You must enable the integration between ASH and AOlong before you can designate a delegated ASH administrator. Only the management account for an organization can designate the delegated ASH administrator account. For more information, see Designating the delegated administrator in the User Guide. To change the delegated administrator account, remove the current delegated administrator account, and then designate the new account. To designate multiple delegated administrators in different organizations and AWS-Regions, we recommend using mappings. Tags aren't supported for this resource.

Link copied to clipboard
Link copied to clipboard
object DelegatedAdminMapper : ResourceMapper<DelegatedAdmin>
Link copied to clipboard
class FindingAggregator : KotlinCustomResource

The `AWS::SecurityHub::FindingAggregator` resource enables cross-Region aggregation. When cross-Region aggregation is enabled, you can aggregate findings, finding updates, insights, control compliance statuses, and security scores from one or more linked Regions to a single aggregation Region. You can then view and manage all of this data from the aggregation Region. For more details about cross-Region aggregation, see Cross-Region aggregation in the User Guide This resource must be created in the Region that you want to designate as your aggregation Region. Cross-Region aggregation is also a prerequisite for using central configuration in ASH.

Link copied to clipboard
data class FindingAggregatorArgs(val regionLinkingMode: Output<FindingAggregatorRegionLinkingMode>? = null, val regions: Output<List<String>>? = null) : ConvertibleToJava<FindingAggregatorArgs>

The `AWS::SecurityHub::FindingAggregator` resource enables cross-Region aggregation. When cross-Region aggregation is enabled, you can aggregate findings, finding updates, insights, control compliance statuses, and security scores from one or more linked Regions to a single aggregation Region. You can then view and manage all of this data from the aggregation Region. For more details about cross-Region aggregation, see Cross-Region aggregation in the User Guide This resource must be created in the Region that you want to designate as your aggregation Region. Cross-Region aggregation is also a prerequisite for using central configuration in ASH.

Link copied to clipboard
object FindingAggregatorMapper : ResourceMapper<FindingAggregator>
Link copied to clipboard
class Hub : KotlinCustomResource

The AWS::SecurityHub::Hub resource represents the implementation of the AWS Security Hub service in your account. One hub resource is created for each Region in which you enable Security Hub.

Link copied to clipboard
data class HubArgs(val autoEnableControls: Output<Boolean>? = null, val controlFindingGenerator: Output<String>? = null, val enableDefaultStandards: Output<Boolean>? = null, val tags: Output<Map<String, String>>? = null) : ConvertibleToJava<HubArgs>

The AWS::SecurityHub::Hub resource represents the implementation of the AWS Security Hub service in your account. One hub resource is created for each Region in which you enable Security Hub.

Link copied to clipboard

Builder for HubArgs.

Link copied to clipboard
object HubMapper : ResourceMapper<Hub>
Link copied to clipboard

Builder for Hub.

Link copied to clipboard
class Insight : KotlinCustomResource

The AWS::SecurityHub::Insight resource represents the AWS Security Hub Insight in your account. An AWS Security Hub insight is a collection of related findings.

Link copied to clipboard
data class InsightArgs(val filters: Output<InsightAwsSecurityFindingFiltersArgs>? = null, val groupByAttribute: Output<String>? = null, val name: Output<String>? = null) : ConvertibleToJava<InsightArgs>

The AWS::SecurityHub::Insight resource represents the AWS Security Hub Insight in your account. An AWS Security Hub insight is a collection of related findings.

Link copied to clipboard
Link copied to clipboard
object InsightMapper : ResourceMapper<Insight>
Link copied to clipboard
Link copied to clipboard
class OrganizationConfiguration : KotlinCustomResource

The AWS::SecurityHub::OrganizationConfiguration resource represents the configuration of your organization in Security Hub. Only the Security Hub administrator account can create Organization Configuration resource in each region and can opt-in to Central Configuration only in the aggregation region of FindingAggregator.

Link copied to clipboard
data class OrganizationConfigurationArgs(val autoEnable: Output<Boolean>? = null, val autoEnableStandards: Output<OrganizationConfigurationAutoEnableStandards>? = null, val configurationType: Output<OrganizationConfigurationConfigurationType>? = null) : ConvertibleToJava<OrganizationConfigurationArgs>

The AWS::SecurityHub::OrganizationConfiguration resource represents the configuration of your organization in Security Hub. Only the Security Hub administrator account can create Organization Configuration resource in each region and can opt-in to Central Configuration only in the aggregation region of FindingAggregator.

Link copied to clipboard
class PolicyAssociation : KotlinCustomResource

The AWS::SecurityHub::PolicyAssociation resource represents the AWS Security Hub Central Configuration Policy associations in your Target. Only the AWS Security Hub delegated administrator can create the resouce from the home region.

Link copied to clipboard
data class PolicyAssociationArgs(val configurationPolicyId: Output<String>? = null, val targetId: Output<String>? = null, val targetType: Output<PolicyAssociationTargetType>? = null) : ConvertibleToJava<PolicyAssociationArgs>

The AWS::SecurityHub::PolicyAssociation resource represents the AWS Security Hub Central Configuration Policy associations in your Target. Only the AWS Security Hub delegated administrator can create the resouce from the home region.

Link copied to clipboard
object PolicyAssociationMapper : ResourceMapper<PolicyAssociation>
Link copied to clipboard
class ProductSubscription : KotlinCustomResource

The AWS::SecurityHub::ProductSubscription resource represents a subscription to a service that is allowed to generate findings for your Security Hub account. One product subscription resource is created for each product enabled.

Link copied to clipboard
data class ProductSubscriptionArgs(val productArn: Output<String>? = null) : ConvertibleToJava<ProductSubscriptionArgs>

The AWS::SecurityHub::ProductSubscription resource represents a subscription to a service that is allowed to generate findings for your Security Hub account. One product subscription resource is created for each product enabled.

Link copied to clipboard
Link copied to clipboard
class SecurityControl : KotlinCustomResource

A security control in Security Hub describes a security best practice related to a specific resource.

Link copied to clipboard
data class SecurityControlArgs(val lastUpdateReason: Output<String>? = null, val parameters: Output<Map<String, SecurityControlParameterConfigurationArgs>>? = null, val securityControlArn: Output<String>? = null, val securityControlId: Output<String>? = null) : ConvertibleToJava<SecurityControlArgs>

A security control in Security Hub describes a security best practice related to a specific resource.

Link copied to clipboard
object SecurityControlMapper : ResourceMapper<SecurityControl>
Link copied to clipboard
Link copied to clipboard
class Standard : KotlinCustomResource

The `AWS::SecurityHub::Standard` resource specifies the enablement of a security standard. The standard is identified by the `StandardsArn` property. To view a list of ASH standards and their Amazon Resource Names (ARNs), use the DescribeStandards API operation. You must create a separate `AWS::SecurityHub::Standard` resource for each standard that you want to enable. For more information about ASH standards, see standards reference in the User Guide.

Link copied to clipboard
data class StandardArgs(val disabledStandardsControls: Output<List<StandardsControlArgs>>? = null, val standardsArn: Output<String>? = null) : ConvertibleToJava<StandardArgs>

The `AWS::SecurityHub::Standard` resource specifies the enablement of a security standard. The standard is identified by the `StandardsArn` property. To view a list of ASH standards and their Amazon Resource Names (ARNs), use the DescribeStandards API operation. You must create a separate `AWS::SecurityHub::Standard` resource for each standard that you want to enable. For more information about ASH standards, see standards reference in the User Guide.

Link copied to clipboard
Link copied to clipboard
object StandardMapper : ResourceMapper<Standard>
Link copied to clipboard

Functions

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun hub(name: String): Hub
suspend fun hub(name: String, block: suspend HubResourceBuilder.() -> Unit): Hub
Link copied to clipboard
fun insight(name: String): Insight
suspend fun insight(name: String, block: suspend InsightResourceBuilder.() -> Unit): Insight
Link copied to clipboard
Link copied to clipboard
suspend fun standard(name: String, block: suspend StandardResourceBuilder.() -> Unit): Standard