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

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi

aws-native.securityhub.PolicyAssociation

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi

    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.

    Create PolicyAssociation Resource

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

    Constructor syntax

    new PolicyAssociation(name: string, args: PolicyAssociationArgs, opts?: CustomResourceOptions);
    @overload
    def PolicyAssociation(resource_name: str,
                          args: PolicyAssociationArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def PolicyAssociation(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          configuration_policy_id: Optional[str] = None,
                          target_id: Optional[str] = None,
                          target_type: Optional[PolicyAssociationTargetType] = None)
    func NewPolicyAssociation(ctx *Context, name string, args PolicyAssociationArgs, opts ...ResourceOption) (*PolicyAssociation, error)
    public PolicyAssociation(string name, PolicyAssociationArgs args, CustomResourceOptions? opts = null)
    public PolicyAssociation(String name, PolicyAssociationArgs args)
    public PolicyAssociation(String name, PolicyAssociationArgs args, CustomResourceOptions options)
    
    type: aws-native:securityhub:PolicyAssociation
    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 PolicyAssociationArgs
    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 PolicyAssociationArgs
    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 PolicyAssociationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicyAssociationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicyAssociationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    ConfigurationPolicyId string
    The universally unique identifier (UUID) of the configuration policy or a value of SELF_MANAGED_SECURITY_HUB for a self-managed configuration
    TargetId string
    The identifier of the target account, organizational unit, or the root
    TargetType Pulumi.AwsNative.SecurityHub.PolicyAssociationTargetType
    Indicates whether the target is an AWS account, organizational unit, or the organization root
    ConfigurationPolicyId string
    The universally unique identifier (UUID) of the configuration policy or a value of SELF_MANAGED_SECURITY_HUB for a self-managed configuration
    TargetId string
    The identifier of the target account, organizational unit, or the root
    TargetType PolicyAssociationTargetType
    Indicates whether the target is an AWS account, organizational unit, or the organization root
    configurationPolicyId String
    The universally unique identifier (UUID) of the configuration policy or a value of SELF_MANAGED_SECURITY_HUB for a self-managed configuration
    targetId String
    The identifier of the target account, organizational unit, or the root
    targetType PolicyAssociationTargetType
    Indicates whether the target is an AWS account, organizational unit, or the organization root
    configurationPolicyId string
    The universally unique identifier (UUID) of the configuration policy or a value of SELF_MANAGED_SECURITY_HUB for a self-managed configuration
    targetId string
    The identifier of the target account, organizational unit, or the root
    targetType PolicyAssociationTargetType
    Indicates whether the target is an AWS account, organizational unit, or the organization root
    configuration_policy_id str
    The universally unique identifier (UUID) of the configuration policy or a value of SELF_MANAGED_SECURITY_HUB for a self-managed configuration
    target_id str
    The identifier of the target account, organizational unit, or the root
    target_type PolicyAssociationTargetType
    Indicates whether the target is an AWS account, organizational unit, or the organization root
    configurationPolicyId String
    The universally unique identifier (UUID) of the configuration policy or a value of SELF_MANAGED_SECURITY_HUB for a self-managed configuration
    targetId String
    The identifier of the target account, organizational unit, or the root
    targetType "ACCOUNT" | "ORGANIZATIONAL_UNIT" | "ROOT"
    Indicates whether the target is an AWS account, organizational unit, or the organization root

    Outputs

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

    AssociationIdentifier string
    A unique identifier to indicates if the target has an association
    AssociationStatus Pulumi.AwsNative.SecurityHub.PolicyAssociationAssociationStatus
    The current status of the association between the specified target and the configuration
    AssociationStatusMessage string
    An explanation for a FAILED value for AssociationStatus
    AssociationType Pulumi.AwsNative.SecurityHub.PolicyAssociationAssociationType
    Indicates whether the association between the specified target and the configuration was directly applied by the Security Hub delegated administrator or inherited from a parent
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    The date and time, in UTC and ISO 8601 format, that the configuration policy association was last updated
    AssociationIdentifier string
    A unique identifier to indicates if the target has an association
    AssociationStatus PolicyAssociationAssociationStatus
    The current status of the association between the specified target and the configuration
    AssociationStatusMessage string
    An explanation for a FAILED value for AssociationStatus
    AssociationType PolicyAssociationAssociationType
    Indicates whether the association between the specified target and the configuration was directly applied by the Security Hub delegated administrator or inherited from a parent
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    The date and time, in UTC and ISO 8601 format, that the configuration policy association was last updated
    associationIdentifier String
    A unique identifier to indicates if the target has an association
    associationStatus PolicyAssociationAssociationStatus
    The current status of the association between the specified target and the configuration
    associationStatusMessage String
    An explanation for a FAILED value for AssociationStatus
    associationType PolicyAssociationAssociationType
    Indicates whether the association between the specified target and the configuration was directly applied by the Security Hub delegated administrator or inherited from a parent
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    The date and time, in UTC and ISO 8601 format, that the configuration policy association was last updated
    associationIdentifier string
    A unique identifier to indicates if the target has an association
    associationStatus PolicyAssociationAssociationStatus
    The current status of the association between the specified target and the configuration
    associationStatusMessage string
    An explanation for a FAILED value for AssociationStatus
    associationType PolicyAssociationAssociationType
    Indicates whether the association between the specified target and the configuration was directly applied by the Security Hub delegated administrator or inherited from a parent
    id string
    The provider-assigned unique ID for this managed resource.
    updatedAt string
    The date and time, in UTC and ISO 8601 format, that the configuration policy association was last updated
    association_identifier str
    A unique identifier to indicates if the target has an association
    association_status PolicyAssociationAssociationStatus
    The current status of the association between the specified target and the configuration
    association_status_message str
    An explanation for a FAILED value for AssociationStatus
    association_type PolicyAssociationAssociationType
    Indicates whether the association between the specified target and the configuration was directly applied by the Security Hub delegated administrator or inherited from a parent
    id str
    The provider-assigned unique ID for this managed resource.
    updated_at str
    The date and time, in UTC and ISO 8601 format, that the configuration policy association was last updated
    associationIdentifier String
    A unique identifier to indicates if the target has an association
    associationStatus "SUCCESS" | "PENDING" | "FAILED"
    The current status of the association between the specified target and the configuration
    associationStatusMessage String
    An explanation for a FAILED value for AssociationStatus
    associationType "APPLIED" | "INHERITED"
    Indicates whether the association between the specified target and the configuration was directly applied by the Security Hub delegated administrator or inherited from a parent
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    The date and time, in UTC and ISO 8601 format, that the configuration policy association was last updated

    Supporting Types

    PolicyAssociationAssociationStatus, PolicyAssociationAssociationStatusArgs

    Success
    SUCCESS
    Pending
    PENDING
    Failed
    FAILED
    PolicyAssociationAssociationStatusSuccess
    SUCCESS
    PolicyAssociationAssociationStatusPending
    PENDING
    PolicyAssociationAssociationStatusFailed
    FAILED
    Success
    SUCCESS
    Pending
    PENDING
    Failed
    FAILED
    Success
    SUCCESS
    Pending
    PENDING
    Failed
    FAILED
    SUCCESS
    SUCCESS
    PENDING
    PENDING
    FAILED
    FAILED
    "SUCCESS"
    SUCCESS
    "PENDING"
    PENDING
    "FAILED"
    FAILED

    PolicyAssociationAssociationType, PolicyAssociationAssociationTypeArgs

    Applied
    APPLIED
    Inherited
    INHERITED
    PolicyAssociationAssociationTypeApplied
    APPLIED
    PolicyAssociationAssociationTypeInherited
    INHERITED
    Applied
    APPLIED
    Inherited
    INHERITED
    Applied
    APPLIED
    Inherited
    INHERITED
    APPLIED
    APPLIED
    INHERITED
    INHERITED
    "APPLIED"
    APPLIED
    "INHERITED"
    INHERITED

    PolicyAssociationTargetType, PolicyAssociationTargetTypeArgs

    Account
    ACCOUNT
    OrganizationalUnit
    ORGANIZATIONAL_UNIT
    Root
    ROOT
    PolicyAssociationTargetTypeAccount
    ACCOUNT
    PolicyAssociationTargetTypeOrganizationalUnit
    ORGANIZATIONAL_UNIT
    PolicyAssociationTargetTypeRoot
    ROOT
    Account
    ACCOUNT
    OrganizationalUnit
    ORGANIZATIONAL_UNIT
    Root
    ROOT
    Account
    ACCOUNT
    OrganizationalUnit
    ORGANIZATIONAL_UNIT
    Root
    ROOT
    ACCOUNT
    ACCOUNT
    ORGANIZATIONAL_UNIT
    ORGANIZATIONAL_UNIT
    ROOT
    ROOT
    "ACCOUNT"
    ACCOUNT
    "ORGANIZATIONAL_UNIT"
    ORGANIZATIONAL_UNIT
    "ROOT"
    ROOT

    Package Details

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

    We recommend new projects start with resources from the AWS provider.

    AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi