This page documents the language specification for the aws package. If you're looking for help working with the inputs, outputs, or functions of aws resources in a Pulumi program, please see the resource documentation for examples and API reference.
guardduty¶
This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.
- class
pulumi_aws.guardduty.AwaitableGetDetectorResult(finding_publishing_frequency=None, id=None, service_role_arn=None, status=None)¶
- class
pulumi_aws.guardduty.Detector(resource_name, opts=None, enable=None, finding_publishing_frequency=None, tags=None, __props__=None, __name__=None, __opts__=None)¶ Provides a resource to manage a GuardDuty detector.
NOTE: Deleting this resource is equivalent to “disabling” GuardDuty for an AWS region, which removes all existing findings. You can set the
enableattribute tofalseto instead “suspend” monitoring and feedback reporting while keeping existing data. See the Suspending or Disabling Amazon GuardDuty documentation for more information.import pulumi import pulumi_aws as aws my_detector = aws.guardduty.Detector("myDetector", enable=True)
- Parameters
resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
enable (pulumi.Input[bool]) – Enable monitoring and feedback reporting. Setting to
falseis equivalent to “suspending” GuardDuty. Defaults totrue.finding_publishing_frequency (pulumi.Input[str]) – Specifies the frequency of notifications sent for subsequent finding occurrences. If the detector is a GuardDuty member account, the value is determined by the GuardDuty master account and cannot be modified, otherwise defaults to
SIX_HOURS. For standalone and GuardDuty master accounts, it must be configured in this provider to enable drift detection. Valid values for standalone and master accounts:FIFTEEN_MINUTES,ONE_HOUR,SIX_HOURS. See AWS Documentation for more information.tags (pulumi.Input[dict]) – Key-value map of resource tags.
account_id: pulumi.Output[str] = None¶The AWS account ID of the GuardDuty detector
arn: pulumi.Output[str] = None¶Amazon Resource Name (ARN) of the GuardDuty detector
enable: pulumi.Output[bool] = None¶Enable monitoring and feedback reporting. Setting to
falseis equivalent to “suspending” GuardDuty. Defaults totrue.
finding_publishing_frequency: pulumi.Output[str] = None¶Specifies the frequency of notifications sent for subsequent finding occurrences. If the detector is a GuardDuty member account, the value is determined by the GuardDuty master account and cannot be modified, otherwise defaults to
SIX_HOURS. For standalone and GuardDuty master accounts, it must be configured in this provider to enable drift detection. Valid values for standalone and master accounts:FIFTEEN_MINUTES,ONE_HOUR,SIX_HOURS. See AWS Documentation for more information.
Key-value map of resource tags.
- static
get(resource_name, id, opts=None, account_id=None, arn=None, enable=None, finding_publishing_frequency=None, tags=None)¶ Get an existing Detector resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
account_id (pulumi.Input[str]) – The AWS account ID of the GuardDuty detector
arn (pulumi.Input[str]) – Amazon Resource Name (ARN) of the GuardDuty detector
enable (pulumi.Input[bool]) – Enable monitoring and feedback reporting. Setting to
falseis equivalent to “suspending” GuardDuty. Defaults totrue.finding_publishing_frequency (pulumi.Input[str]) –
Specifies the frequency of notifications sent for subsequent finding occurrences. If the detector is a GuardDuty member account, the value is determined by the GuardDuty master account and cannot be modified, otherwise defaults to
SIX_HOURS. For standalone and GuardDuty master accounts, it must be configured in this provider to enable drift detection. Valid values for standalone and master accounts:FIFTEEN_MINUTES,ONE_HOUR,SIX_HOURS. See AWS Documentation for more information.tags (pulumi.Input[dict]) – Key-value map of resource tags.
translate_output_property(prop)¶Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
translate_input_property(prop)¶Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
- class
pulumi_aws.guardduty.GetDetectorResult(finding_publishing_frequency=None, id=None, service_role_arn=None, status=None)¶ A collection of values returned by getDetector.
finding_publishing_frequency= None¶The frequency of notifications sent about subsequent finding occurrences.
service_role_arn= None¶The service-linked role that grants GuardDuty access to the resources in the AWS account.
status= None¶The current status of the detector.
- class
pulumi_aws.guardduty.IPSet(resource_name, opts=None, activate=None, detector_id=None, format=None, location=None, name=None, tags=None, __props__=None, __name__=None, __opts__=None)¶ Provides a resource to manage a GuardDuty IPSet.
Note: Currently in GuardDuty, users from member accounts cannot upload and further manage IPSets. IPSets that are uploaded by the master account are imposed on GuardDuty functionality in its member accounts. See the GuardDuty API Documentation
import pulumi import pulumi_aws as aws master = aws.guardduty.Detector("master", enable=True) bucket = aws.s3.Bucket("bucket", acl="private") my_ip_set_bucket_object = aws.s3.BucketObject("myIPSetBucketObject", acl="public-read", bucket=bucket.id, content="""10.0.0.0/8 """, key="MyIPSet") my_ip_set_ip_set = aws.guardduty.IPSet("myIPSetIPSet", activate=True, detector_id=master.id, format="TXT", location=pulumi.Output.all(my_ip_set_bucket_object.bucket, my_ip_set_bucket_object.key).apply(lambda bucket, key: f"https://s3.amazonaws.com/{bucket}/{key}"))
- Parameters
resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
activate (pulumi.Input[bool]) – Specifies whether GuardDuty is to start using the uploaded IPSet.
detector_id (pulumi.Input[str]) – The detector ID of the GuardDuty.
format (pulumi.Input[str]) – The format of the file that contains the IPSet. Valid values:
TXT|STIX|OTX_CSV|ALIEN_VAULT|PROOF_POINT|FIRE_EYElocation (pulumi.Input[str]) – The URI of the file that contains the IPSet.
name (pulumi.Input[str]) – The friendly name to identify the IPSet.
tags (pulumi.Input[dict]) – Key-value map of resource tags.
activate: pulumi.Output[bool] = None¶Specifies whether GuardDuty is to start using the uploaded IPSet.
arn: pulumi.Output[str] = None¶Amazon Resource Name (ARN) of the GuardDuty IPSet.
detector_id: pulumi.Output[str] = None¶The detector ID of the GuardDuty.
format: pulumi.Output[str] = None¶The format of the file that contains the IPSet. Valid values:
TXT|STIX|OTX_CSV|ALIEN_VAULT|PROOF_POINT|FIRE_EYE
location: pulumi.Output[str] = None¶The URI of the file that contains the IPSet.
name: pulumi.Output[str] = None¶The friendly name to identify the IPSet.
Key-value map of resource tags.
- static
get(resource_name, id, opts=None, activate=None, arn=None, detector_id=None, format=None, location=None, name=None, tags=None)¶ Get an existing IPSet resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
activate (pulumi.Input[bool]) – Specifies whether GuardDuty is to start using the uploaded IPSet.
arn (pulumi.Input[str]) – Amazon Resource Name (ARN) of the GuardDuty IPSet.
detector_id (pulumi.Input[str]) – The detector ID of the GuardDuty.
format (pulumi.Input[str]) – The format of the file that contains the IPSet. Valid values:
TXT|STIX|OTX_CSV|ALIEN_VAULT|PROOF_POINT|FIRE_EYElocation (pulumi.Input[str]) – The URI of the file that contains the IPSet.
name (pulumi.Input[str]) – The friendly name to identify the IPSet.
tags (pulumi.Input[dict]) – Key-value map of resource tags.
translate_output_property(prop)¶Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
translate_input_property(prop)¶Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
- class
pulumi_aws.guardduty.InviteAccepter(resource_name, opts=None, detector_id=None, master_account_id=None, __props__=None, __name__=None, __opts__=None)¶ Provides a resource to accept a pending GuardDuty invite on creation, ensure the detector has the correct master account on read, and disassociate with the master account upon removal.
import pulumi import pulumi_aws as aws master = aws.guardduty.Detector("master") member_detector = aws.guardduty.Detector("memberDetector") dev = aws.guardduty.Member("dev", account_id=member_detector.account_id, detector_id=master.id, email="required@example.com", invite=True) member_invite_accepter = aws.guardduty.InviteAccepter("memberInviteAccepter", detector_id=member_detector.id, master_account_id=master.account_id)
- Parameters
resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
detector_id (pulumi.Input[str]) – The detector ID of the member GuardDuty account.
master_account_id (pulumi.Input[str]) – AWS account ID for master account.
detector_id: pulumi.Output[str] = None¶The detector ID of the member GuardDuty account.
master_account_id: pulumi.Output[str] = None¶AWS account ID for master account.
- static
get(resource_name, id, opts=None, detector_id=None, master_account_id=None)¶ Get an existing InviteAccepter resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
detector_id (pulumi.Input[str]) – The detector ID of the member GuardDuty account.
master_account_id (pulumi.Input[str]) – AWS account ID for master account.
translate_output_property(prop)¶Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
translate_input_property(prop)¶Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
- class
pulumi_aws.guardduty.Member(resource_name, opts=None, account_id=None, detector_id=None, disable_email_notification=None, email=None, invitation_message=None, invite=None, __props__=None, __name__=None, __opts__=None)¶ Provides a resource to manage a GuardDuty member. To accept invitations in member accounts, see the
guardduty.InviteAccepterresource.import pulumi import pulumi_aws as aws master = aws.guardduty.Detector("master", enable=True) member_detector = aws.guardduty.Detector("memberDetector", enable=True) member_member = aws.guardduty.Member("memberMember", account_id=member_detector.account_id, detector_id=master.id, email="required@example.com", invite=True, invitation_message="please accept guardduty invitation")
- Parameters
resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
account_id (pulumi.Input[str]) – AWS account ID for member account.
detector_id (pulumi.Input[str]) – The detector ID of the GuardDuty account where you want to create member accounts.
disable_email_notification (pulumi.Input[bool]) – Boolean whether an email notification is sent to the accounts. Defaults to
false.email (pulumi.Input[str]) – Email address for member account.
invitation_message (pulumi.Input[str]) – Message for invitation.
invite (pulumi.Input[bool]) – Boolean whether to invite the account to GuardDuty as a member. Defaults to
false. To detect if an invitation needs to be (re-)sent, the this provider state value istruebased on arelationship_statusofDisabled,Enabled,Invited, orEmailVerificationInProgress.
account_id: pulumi.Output[str] = None¶AWS account ID for member account.
detector_id: pulumi.Output[str] = None¶The detector ID of the GuardDuty account where you want to create member accounts.
disable_email_notification: pulumi.Output[bool] = None¶Boolean whether an email notification is sent to the accounts. Defaults to
false.
email: pulumi.Output[str] = None¶Email address for member account.
invitation_message: pulumi.Output[str] = None¶Message for invitation.
invite: pulumi.Output[bool] = None¶Boolean whether to invite the account to GuardDuty as a member. Defaults to
false. To detect if an invitation needs to be (re-)sent, the this provider state value istruebased on arelationship_statusofDisabled,Enabled,Invited, orEmailVerificationInProgress.
relationship_status: pulumi.Output[str] = None¶The status of the relationship between the member account and its master account. More information can be found in Amazon GuardDuty API Reference.
- static
get(resource_name, id, opts=None, account_id=None, detector_id=None, disable_email_notification=None, email=None, invitation_message=None, invite=None, relationship_status=None)¶ Get an existing Member resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
account_id (pulumi.Input[str]) – AWS account ID for member account.
detector_id (pulumi.Input[str]) – The detector ID of the GuardDuty account where you want to create member accounts.
disable_email_notification (pulumi.Input[bool]) – Boolean whether an email notification is sent to the accounts. Defaults to
false.email (pulumi.Input[str]) – Email address for member account.
invitation_message (pulumi.Input[str]) – Message for invitation.
invite (pulumi.Input[bool]) – Boolean whether to invite the account to GuardDuty as a member. Defaults to
false. To detect if an invitation needs to be (re-)sent, the this provider state value istruebased on arelationship_statusofDisabled,Enabled,Invited, orEmailVerificationInProgress.relationship_status (pulumi.Input[str]) –
The status of the relationship between the member account and its master account. More information can be found in Amazon GuardDuty API Reference.
translate_output_property(prop)¶Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
translate_input_property(prop)¶Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
- class
pulumi_aws.guardduty.OrganizationAdminAccount(resource_name, opts=None, admin_account_id=None, __props__=None, __name__=None, __opts__=None)¶ Manages a GuardDuty Organization Admin Account. The AWS account utilizing this resource must be an Organizations master account. More information about Organizations support in GuardDuty can be found in the GuardDuty User Guide.
import pulumi import pulumi_aws as aws example_organization = aws.organizations.Organization("exampleOrganization", aws_service_access_principals=["guardduty.amazonaws.com"], feature_set="ALL") example_detector = aws.guardduty.Detector("exampleDetector") example_organization_admin_account = aws.guardduty.OrganizationAdminAccount("exampleOrganizationAdminAccount", admin_account_id="123456789012")
- Parameters
resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
admin_account_id (pulumi.Input[str]) – AWS account identifier to designate as a delegated administrator for GuardDuty.
admin_account_id: pulumi.Output[str] = None¶AWS account identifier to designate as a delegated administrator for GuardDuty.
- static
get(resource_name, id, opts=None, admin_account_id=None)¶ Get an existing OrganizationAdminAccount resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
admin_account_id (pulumi.Input[str]) – AWS account identifier to designate as a delegated administrator for GuardDuty.
translate_output_property(prop)¶Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
translate_input_property(prop)¶Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
- class
pulumi_aws.guardduty.OrganizationConfiguration(resource_name, opts=None, auto_enable=None, detector_id=None, __props__=None, __name__=None, __opts__=None)¶ Manages the GuardDuty Organization Configuration in the current AWS Region. The AWS account utilizing this resource must have been assigned as a delegated Organization administrator account, e.g. via the
guardduty.OrganizationAdminAccountresource. More information about Organizations support in GuardDuty can be found in the GuardDuty User Guide.NOTE: This is an advanced resource. The provider will automatically assume management of the GuardDuty Organization Configuration without import and perform no actions on removal from the resource configuration.
import pulumi import pulumi_aws as aws example_detector = aws.guardduty.Detector("exampleDetector", enable=True) example_organization_configuration = aws.guardduty.OrganizationConfiguration("exampleOrganizationConfiguration", auto_enable=True, detector_id=example_detector.id)
- Parameters
resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
auto_enable (pulumi.Input[bool]) – When this setting is enabled, all new accounts that are created in, or added to, the organization are added as a member accounts of the organization’s GuardDuty delegated administrator and GuardDuty is enabled in that AWS Region.
detector_id (pulumi.Input[str]) – The detector ID of the GuardDuty account.
auto_enable: pulumi.Output[bool] = None¶When this setting is enabled, all new accounts that are created in, or added to, the organization are added as a member accounts of the organization’s GuardDuty delegated administrator and GuardDuty is enabled in that AWS Region.
detector_id: pulumi.Output[str] = None¶The detector ID of the GuardDuty account.
- static
get(resource_name, id, opts=None, auto_enable=None, detector_id=None)¶ Get an existing OrganizationConfiguration resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
auto_enable (pulumi.Input[bool]) – When this setting is enabled, all new accounts that are created in, or added to, the organization are added as a member accounts of the organization’s GuardDuty delegated administrator and GuardDuty is enabled in that AWS Region.
detector_id (pulumi.Input[str]) – The detector ID of the GuardDuty account.
translate_output_property(prop)¶Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
translate_input_property(prop)¶Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
- class
pulumi_aws.guardduty.ThreatIntelSet(resource_name, opts=None, activate=None, detector_id=None, format=None, location=None, name=None, tags=None, __props__=None, __name__=None, __opts__=None)¶ Provides a resource to manage a GuardDuty ThreatIntelSet.
Note: Currently in GuardDuty, users from member accounts cannot upload and further manage ThreatIntelSets. ThreatIntelSets that are uploaded by the master account are imposed on GuardDuty functionality in its member accounts. See the GuardDuty API Documentation
import pulumi import pulumi_aws as aws master = aws.guardduty.Detector("master", enable=True) bucket = aws.s3.Bucket("bucket", acl="private") my_threat_intel_set_bucket_object = aws.s3.BucketObject("myThreatIntelSetBucketObject", acl="public-read", bucket=bucket.id, content="""10.0.0.0/8 """, key="MyThreatIntelSet") my_threat_intel_set_threat_intel_set = aws.guardduty.ThreatIntelSet("myThreatIntelSetThreatIntelSet", activate=True, detector_id=master.id, format="TXT", location=pulumi.Output.all(my_threat_intel_set_bucket_object.bucket, my_threat_intel_set_bucket_object.key).apply(lambda bucket, key: f"https://s3.amazonaws.com/{bucket}/{key}"))
- Parameters
resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
activate (pulumi.Input[bool]) – Specifies whether GuardDuty is to start using the uploaded ThreatIntelSet.
detector_id (pulumi.Input[str]) – The detector ID of the GuardDuty.
format (pulumi.Input[str]) – The format of the file that contains the ThreatIntelSet. Valid values:
TXT|STIX|OTX_CSV|ALIEN_VAULT|PROOF_POINT|FIRE_EYElocation (pulumi.Input[str]) – The URI of the file that contains the ThreatIntelSet.
name (pulumi.Input[str]) – The friendly name to identify the ThreatIntelSet.
tags (pulumi.Input[dict]) – Key-value map of resource tags.
activate: pulumi.Output[bool] = None¶Specifies whether GuardDuty is to start using the uploaded ThreatIntelSet.
arn: pulumi.Output[str] = None¶Amazon Resource Name (ARN) of the GuardDuty ThreatIntelSet.
detector_id: pulumi.Output[str] = None¶The detector ID of the GuardDuty.
format: pulumi.Output[str] = None¶The format of the file that contains the ThreatIntelSet. Valid values:
TXT|STIX|OTX_CSV|ALIEN_VAULT|PROOF_POINT|FIRE_EYE
location: pulumi.Output[str] = None¶The URI of the file that contains the ThreatIntelSet.
name: pulumi.Output[str] = None¶The friendly name to identify the ThreatIntelSet.
Key-value map of resource tags.
- static
get(resource_name, id, opts=None, activate=None, arn=None, detector_id=None, format=None, location=None, name=None, tags=None)¶ Get an existing ThreatIntelSet resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
activate (pulumi.Input[bool]) – Specifies whether GuardDuty is to start using the uploaded ThreatIntelSet.
arn (pulumi.Input[str]) – Amazon Resource Name (ARN) of the GuardDuty ThreatIntelSet.
detector_id (pulumi.Input[str]) – The detector ID of the GuardDuty.
format (pulumi.Input[str]) – The format of the file that contains the ThreatIntelSet. Valid values:
TXT|STIX|OTX_CSV|ALIEN_VAULT|PROOF_POINT|FIRE_EYElocation (pulumi.Input[str]) – The URI of the file that contains the ThreatIntelSet.
name (pulumi.Input[str]) – The friendly name to identify the ThreatIntelSet.
tags (pulumi.Input[dict]) – Key-value map of resource tags.
translate_output_property(prop)¶Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
translate_input_property(prop)¶Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
pulumi_aws.guardduty.get_detector(id=None, opts=None)¶Retrieve information about a GuardDuty detector.
import pulumi import pulumi_aws as aws example = aws.guardduty.get_detector()
- Parameters
id (str) – The ID of the detector.