1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. guardduty
  6. CustomDetectionRuleAssociation

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

Viewing docs for AWS Cloud Control v1.86.0
published on Wednesday, Nov 18, 2026 by Pulumi
aws-native logo aws-native logo AWS Cloud Control

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

Viewing docs for AWS Cloud Control v1.86.0
published on Wednesday, Nov 18, 2026 by Pulumi

    Resource Type definition for AWS::GuardDuty::CustomDetectionRuleAssociation. Associates a GuardDuty custom detection rule with the caller’s account, enabling the rule in either LIVE or DRY_RUN mode.

    Create CustomDetectionRuleAssociation Resource

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

    Constructor syntax

    new CustomDetectionRuleAssociation(name: string, args: CustomDetectionRuleAssociationArgs, opts?: CustomResourceOptions);
    @overload
    def CustomDetectionRuleAssociation(resource_name: str,
                                       args: CustomDetectionRuleAssociationArgs,
                                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def CustomDetectionRuleAssociation(resource_name: str,
                                       opts: Optional[ResourceOptions] = None,
                                       mode: Optional[CustomDetectionRuleAssociationMode] = None,
                                       rule_id: Optional[str] = None,
                                       tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewCustomDetectionRuleAssociation(ctx *Context, name string, args CustomDetectionRuleAssociationArgs, opts ...ResourceOption) (*CustomDetectionRuleAssociation, error)
    public CustomDetectionRuleAssociation(string name, CustomDetectionRuleAssociationArgs args, CustomResourceOptions? opts = null)
    public CustomDetectionRuleAssociation(String name, CustomDetectionRuleAssociationArgs args)
    public CustomDetectionRuleAssociation(String name, CustomDetectionRuleAssociationArgs args, CustomResourceOptions options)
    
    type: aws-native:guardduty:CustomDetectionRuleAssociation
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "aws-native_guardduty_custom_detection_rule_association" "name" {
        # resource properties
    }

    Parameters

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

    CustomDetectionRuleAssociation Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The CustomDetectionRuleAssociation resource accepts the following input properties:

    Mode Pulumi.AwsNative.GuardDuty.CustomDetectionRuleAssociationMode
    Whether the rule runs in LIVE mode (generates findings) or DRY_RUN mode (evaluates without generating findings).
    RuleId string
    The catalog identifier of the custom detection rule to associate.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    The tags applied to the association.
    Mode CustomDetectionRuleAssociationMode
    Whether the rule runs in LIVE mode (generates findings) or DRY_RUN mode (evaluates without generating findings).
    RuleId string
    The catalog identifier of the custom detection rule to associate.
    Tags TagArgs
    The tags applied to the association.
    mode "LIVE" | "DRY_RUN"
    Whether the rule runs in LIVE mode (generates findings) or DRY_RUN mode (evaluates without generating findings).
    rule_id string
    The catalog identifier of the custom detection rule to associate.
    tags list(object)
    The tags applied to the association.
    mode CustomDetectionRuleAssociationMode
    Whether the rule runs in LIVE mode (generates findings) or DRY_RUN mode (evaluates without generating findings).
    ruleId String
    The catalog identifier of the custom detection rule to associate.
    tags List<Tag>
    The tags applied to the association.
    mode CustomDetectionRuleAssociationMode
    Whether the rule runs in LIVE mode (generates findings) or DRY_RUN mode (evaluates without generating findings).
    ruleId string
    The catalog identifier of the custom detection rule to associate.
    tags Tag[]
    The tags applied to the association.
    mode CustomDetectionRuleAssociationMode
    Whether the rule runs in LIVE mode (generates findings) or DRY_RUN mode (evaluates without generating findings).
    rule_id str
    The catalog identifier of the custom detection rule to associate.
    tags Sequence[TagArgs]
    The tags applied to the association.
    mode "LIVE" | "DRY_RUN"
    Whether the rule runs in LIVE mode (generates findings) or DRY_RUN mode (evaluates without generating findings).
    ruleId String
    The catalog identifier of the custom detection rule to associate.
    tags List<Property Map>
    The tags applied to the association.

    Outputs

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

    AccountId string
    The AWS account ID the association applies to.
    Arn string
    The Amazon Resource Name (ARN) of the association.
    AssociationId string
    The service-generated unique identifier of the association.
    CreatedAt string
    The time the association was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    The time the association was last updated.
    AccountId string
    The AWS account ID the association applies to.
    Arn string
    The Amazon Resource Name (ARN) of the association.
    AssociationId string
    The service-generated unique identifier of the association.
    CreatedAt string
    The time the association was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    The time the association was last updated.
    account_id string
    The AWS account ID the association applies to.
    arn string
    The Amazon Resource Name (ARN) of the association.
    association_id string
    The service-generated unique identifier of the association.
    created_at string
    The time the association was created.
    id string
    The provider-assigned unique ID for this managed resource.
    updated_at string
    The time the association was last updated.
    accountId String
    The AWS account ID the association applies to.
    arn String
    The Amazon Resource Name (ARN) of the association.
    associationId String
    The service-generated unique identifier of the association.
    createdAt String
    The time the association was created.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    The time the association was last updated.
    accountId string
    The AWS account ID the association applies to.
    arn string
    The Amazon Resource Name (ARN) of the association.
    associationId string
    The service-generated unique identifier of the association.
    createdAt string
    The time the association was created.
    id string
    The provider-assigned unique ID for this managed resource.
    updatedAt string
    The time the association was last updated.
    account_id str
    The AWS account ID the association applies to.
    arn str
    The Amazon Resource Name (ARN) of the association.
    association_id str
    The service-generated unique identifier of the association.
    created_at str
    The time the association was created.
    id str
    The provider-assigned unique ID for this managed resource.
    updated_at str
    The time the association was last updated.
    accountId String
    The AWS account ID the association applies to.
    arn String
    The Amazon Resource Name (ARN) of the association.
    associationId String
    The service-generated unique identifier of the association.
    createdAt String
    The time the association was created.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    The time the association was last updated.

    Look up Existing CustomDetectionRuleAssociation Resource

    Get an existing CustomDetectionRuleAssociation 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>, opts?: CustomResourceOptions): CustomDetectionRuleAssociation
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None) -> CustomDetectionRuleAssociation
    func GetCustomDetectionRuleAssociation(ctx *Context, name string, id IDInput, state *CustomDetectionRuleAssociationState, opts ...ResourceOption) (*CustomDetectionRuleAssociation, error)
    public static CustomDetectionRuleAssociation Get(string name, Input<string> id, CustomResourceOptions? opts = null)
    public static CustomDetectionRuleAssociation get(String name, Output<String> id, CustomResourceOptions options)
    resources:  existingCustomDetectionRuleAssociation:    type: aws-native:guardduty:CustomDetectionRuleAssociation    get:      id: ${id}
    import {
      to = aws-native_guardduty_custom_detection_rule_association.example
      id = "${id}"
    }
    
    name string
    The unique name of the resulting resource.
    id Input<ID>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resulting resource.
    id str
    The unique provider ID of the resource to look up.
    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 resulting resource.
    id IDInput
    The unique provider ID of the resource to look up.
    state CustomDetectionRuleAssociationState
    Pass nil. This resource has no state arguments.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resulting resource.
    id Input<string>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resulting resource.
    id Output<String>
    The unique provider ID of the resource to look up.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Supporting Types

    CustomDetectionRuleAssociationMode

    Whether the rule runs in LIVE mode (generates findings) or DRY_RUN mode (evaluates without generating findings).

    NameValue
    LiveLIVE
    DryRunDRY_RUN
    NameValue
    CustomDetectionRuleAssociationModeLiveLIVE
    CustomDetectionRuleAssociationModeDryRunDRY_RUN
    Value
    LIVE
    DRY_RUN
    NameValue
    LiveLIVE
    DryRunDRY_RUN
    NameValue
    LiveLIVE
    DryRunDRY_RUN
    NameValue
    LIVELIVE
    DRY_RUNDRY_RUN
    Value
    LIVE
    DRY_RUN

    Tag, TagArgs

    A set of tags to apply to the resource.

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

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

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

    Viewing docs for AWS Cloud Control v1.86.0
    published on Wednesday, Nov 18, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial