aws.guardduty.OrganizationAdminAccount
Explore with Pulumi AI
Manages a GuardDuty Organization Admin Account. The AWS account utilizing this resource must be an Organizations primary account. More information about Organizations support in GuardDuty can be found in the GuardDuty User Guide.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.organizations.Organization("example", {
awsServiceAccessPrincipals: ["guardduty.amazonaws.com"],
featureSet: "ALL",
});
const exampleDetector = new aws.guardduty.Detector("example", {});
const exampleOrganizationAdminAccount = new aws.guardduty.OrganizationAdminAccount("example", {adminAccountId: "123456789012"}, {
dependsOn: [example],
});
import pulumi
import pulumi_aws as aws
example = aws.organizations.Organization("example",
aws_service_access_principals=["guardduty.amazonaws.com"],
feature_set="ALL")
example_detector = aws.guardduty.Detector("example")
example_organization_admin_account = aws.guardduty.OrganizationAdminAccount("example", admin_account_id="123456789012",
opts = pulumi.ResourceOptions(depends_on=[example]))
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/guardduty"
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/organizations"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := organizations.NewOrganization(ctx, "example", &organizations.OrganizationArgs{
AwsServiceAccessPrincipals: pulumi.StringArray{
pulumi.String("guardduty.amazonaws.com"),
},
FeatureSet: pulumi.String("ALL"),
})
if err != nil {
return err
}
_, err = guardduty.NewDetector(ctx, "example", nil)
if err != nil {
return err
}
_, err = guardduty.NewOrganizationAdminAccount(ctx, "example", &guardduty.OrganizationAdminAccountArgs{
AdminAccountId: pulumi.String("123456789012"),
}, pulumi.DependsOn([]pulumi.Resource{
example,
}))
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Organizations.Organization("example", new()
{
AwsServiceAccessPrincipals = new[]
{
"guardduty.amazonaws.com",
},
FeatureSet = "ALL",
});
var exampleDetector = new Aws.GuardDuty.Detector("example");
var exampleOrganizationAdminAccount = new Aws.GuardDuty.OrganizationAdminAccount("example", new()
{
AdminAccountId = "123456789012",
}, new CustomResourceOptions
{
DependsOn =
{
example,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.organizations.Organization;
import com.pulumi.aws.organizations.OrganizationArgs;
import com.pulumi.aws.guardduty.Detector;
import com.pulumi.aws.guardduty.OrganizationAdminAccount;
import com.pulumi.aws.guardduty.OrganizationAdminAccountArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new Organization("example", OrganizationArgs.builder()
.awsServiceAccessPrincipals("guardduty.amazonaws.com")
.featureSet("ALL")
.build());
var exampleDetector = new Detector("exampleDetector");
var exampleOrganizationAdminAccount = new OrganizationAdminAccount("exampleOrganizationAdminAccount", OrganizationAdminAccountArgs.builder()
.adminAccountId("123456789012")
.build(), CustomResourceOptions.builder()
.dependsOn(example)
.build());
}
}
resources:
example:
type: aws:organizations:Organization
properties:
awsServiceAccessPrincipals:
- guardduty.amazonaws.com
featureSet: ALL
exampleDetector:
type: aws:guardduty:Detector
name: example
exampleOrganizationAdminAccount:
type: aws:guardduty:OrganizationAdminAccount
name: example
properties:
adminAccountId: '123456789012'
options:
dependson:
- ${example}
Create OrganizationAdminAccount Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new OrganizationAdminAccount(name: string, args: OrganizationAdminAccountArgs, opts?: CustomResourceOptions);
@overload
def OrganizationAdminAccount(resource_name: str,
args: OrganizationAdminAccountArgs,
opts: Optional[ResourceOptions] = None)
@overload
def OrganizationAdminAccount(resource_name: str,
opts: Optional[ResourceOptions] = None,
admin_account_id: Optional[str] = None)
func NewOrganizationAdminAccount(ctx *Context, name string, args OrganizationAdminAccountArgs, opts ...ResourceOption) (*OrganizationAdminAccount, error)
public OrganizationAdminAccount(string name, OrganizationAdminAccountArgs args, CustomResourceOptions? opts = null)
public OrganizationAdminAccount(String name, OrganizationAdminAccountArgs args)
public OrganizationAdminAccount(String name, OrganizationAdminAccountArgs args, CustomResourceOptions options)
type: aws:guardduty:OrganizationAdminAccount
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 OrganizationAdminAccountArgs
- 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 OrganizationAdminAccountArgs
- 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 OrganizationAdminAccountArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args OrganizationAdminAccountArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args OrganizationAdminAccountArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var awsOrganizationAdminAccountResource = new Aws.GuardDuty.OrganizationAdminAccount("awsOrganizationAdminAccountResource", new()
{
AdminAccountId = "string",
});
example, err := guardduty.NewOrganizationAdminAccount(ctx, "awsOrganizationAdminAccountResource", &guardduty.OrganizationAdminAccountArgs{
AdminAccountId: pulumi.String("string"),
})
var awsOrganizationAdminAccountResource = new OrganizationAdminAccount("awsOrganizationAdminAccountResource", OrganizationAdminAccountArgs.builder()
.adminAccountId("string")
.build());
aws_organization_admin_account_resource = aws.guardduty.OrganizationAdminAccount("awsOrganizationAdminAccountResource", admin_account_id="string")
const awsOrganizationAdminAccountResource = new aws.guardduty.OrganizationAdminAccount("awsOrganizationAdminAccountResource", {adminAccountId: "string"});
type: aws:guardduty:OrganizationAdminAccount
properties:
adminAccountId: string
OrganizationAdminAccount 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 OrganizationAdminAccount resource accepts the following input properties:
- Admin
Account stringId - AWS account identifier to designate as a delegated administrator for GuardDuty.
- Admin
Account stringId - AWS account identifier to designate as a delegated administrator for GuardDuty.
- admin
Account StringId - AWS account identifier to designate as a delegated administrator for GuardDuty.
- admin
Account stringId - AWS account identifier to designate as a delegated administrator for GuardDuty.
- admin_
account_ strid - AWS account identifier to designate as a delegated administrator for GuardDuty.
- admin
Account StringId - AWS account identifier to designate as a delegated administrator for GuardDuty.
Outputs
All input properties are implicitly available as output properties. Additionally, the OrganizationAdminAccount resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing OrganizationAdminAccount Resource
Get an existing OrganizationAdminAccount 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>, state?: OrganizationAdminAccountState, opts?: CustomResourceOptions): OrganizationAdminAccount
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
admin_account_id: Optional[str] = None) -> OrganizationAdminAccount
func GetOrganizationAdminAccount(ctx *Context, name string, id IDInput, state *OrganizationAdminAccountState, opts ...ResourceOption) (*OrganizationAdminAccount, error)
public static OrganizationAdminAccount Get(string name, Input<string> id, OrganizationAdminAccountState? state, CustomResourceOptions? opts = null)
public static OrganizationAdminAccount get(String name, Output<String> id, OrganizationAdminAccountState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Admin
Account stringId - AWS account identifier to designate as a delegated administrator for GuardDuty.
- Admin
Account stringId - AWS account identifier to designate as a delegated administrator for GuardDuty.
- admin
Account StringId - AWS account identifier to designate as a delegated administrator for GuardDuty.
- admin
Account stringId - AWS account identifier to designate as a delegated administrator for GuardDuty.
- admin_
account_ strid - AWS account identifier to designate as a delegated administrator for GuardDuty.
- admin
Account StringId - AWS account identifier to designate as a delegated administrator for GuardDuty.
Import
Using pulumi import
, import GuardDuty Organization Admin Account using the AWS account ID. For example:
$ pulumi import aws:guardduty/organizationAdminAccount:OrganizationAdminAccount example 123456789012
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.