Start Configuration Policy Association

securityhub_start_configuration_policy_association

R Documentation

Associates a target account, organizational unit, or the root with a specified configuration¶

Description¶

Associates a target account, organizational unit, or the root with a specified configuration. The target can be associated with a configuration policy or self-managed behavior. Only the Security Hub delegated administrator can invoke this operation from the home Region.

Usage¶

securityhub_start_configuration_policy_association(
  ConfigurationPolicyIdentifier, Target)

Arguments¶

ConfigurationPolicyIdentifier: [required] The Amazon Resource Name (ARN) of a configuration policy, the universally unique identifier (UUID) of a configuration policy, or a value of SELF_MANAGED_SECURITY_HUB for a self-managed configuration.
Target: [required] The identifier of the target account, organizational unit, or the root to associate with the specified configuration.

Value¶

A list with the following syntax:

list(
  ConfigurationPolicyId = "string",
  TargetId = "string",
  TargetType = "ACCOUNT"|"ORGANIZATIONAL_UNIT"|"ROOT",
  AssociationType = "INHERITED"|"APPLIED",
  UpdatedAt = as.POSIXct(
    "2015-01-01"
  ),
  AssociationStatus = "PENDING"|"SUCCESS"|"FAILED",
  AssociationStatusMessage = "string"
)

Request syntax¶

svc$start_configuration_policy_association(
  ConfigurationPolicyIdentifier = "string",
  Target = list(
    AccountId = "string",
    OrganizationalUnitId = "string",
    RootId = "string"
  )
)

Examples¶

## Not run: 
# This operation associates a configuration policy or self-managed
# behavior with the target account, organizational unit, or the root.
svc$start_configuration_policy_association(
  ConfigurationPolicyIdentifier = "arn:aws:securityhub:us-east-1:1234567890...",
  Target = list(
    AccountId = "111122223333"
  )
)

## End(Not run)