Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. auditmanager
  5. AccountRegistration
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.auditmanager.AccountRegistration

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

    Resource for managing AWS Audit Manager Account Registration.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.auditmanager.AccountRegistration("example", {});

    import pulumi
import pulumi_aws as aws

example = aws.auditmanager.AccountRegistration("example")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/auditmanager"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := auditmanager.NewAccountRegistration(ctx, "example", nil)
		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.Auditmanager.AccountRegistration("example");

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.auditmanager.AccountRegistration;
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 AccountRegistration("example");

    }
}

    resources:
  example:
    type: aws:auditmanager:AccountRegistration

    Deregister On Destroy

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.auditmanager.AccountRegistration("example", {deregisterOnDestroy: true});

    import pulumi
import pulumi_aws as aws

example = aws.auditmanager.AccountRegistration("example", deregister_on_destroy=True)

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/auditmanager"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := auditmanager.NewAccountRegistration(ctx, "example", &auditmanager.AccountRegistrationArgs{
			DeregisterOnDestroy: pulumi.Bool(true),
		})
		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.Auditmanager.AccountRegistration("example", new()
    {
        DeregisterOnDestroy = true,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.auditmanager.AccountRegistration;
import com.pulumi.aws.auditmanager.AccountRegistrationArgs;
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 AccountRegistration("example", AccountRegistrationArgs.builder()
            .deregisterOnDestroy(true)
            .build());

    }
}

    resources:
  example:
    type: aws:auditmanager:AccountRegistration
    properties:
      deregisterOnDestroy: true

    Create AccountRegistration Resource

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

    Constructor syntax

    new AccountRegistration(name: string, args?: AccountRegistrationArgs, opts?: CustomResourceOptions);
    @overload
def AccountRegistration(resource_name: str,
                        args: Optional[AccountRegistrationArgs] = None,
                        opts: Optional[ResourceOptions] = None)

@overload
def AccountRegistration(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        delegated_admin_account: Optional[str] = None,
                        deregister_on_destroy: Optional[bool] = None,
                        kms_key: Optional[str] = None)
    func NewAccountRegistration(ctx *Context, name string, args *AccountRegistrationArgs, opts ...ResourceOption) (*AccountRegistration, error)
    public AccountRegistration(string name, AccountRegistrationArgs? args = null, CustomResourceOptions? opts = null)
    public AccountRegistration(String name, AccountRegistrationArgs args)
public AccountRegistration(String name, AccountRegistrationArgs args, CustomResourceOptions options)

    type: aws:auditmanager:AccountRegistration
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 AccountRegistrationArgs
    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 AccountRegistrationArgs
    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 AccountRegistrationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AccountRegistrationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AccountRegistrationArgs
    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 accountRegistrationResource = new Aws.Auditmanager.AccountRegistration("accountRegistrationResource", new()
{
    DelegatedAdminAccount = "string",
    DeregisterOnDestroy = false,
    KmsKey = "string",
});

    example, err := auditmanager.NewAccountRegistration(ctx, "accountRegistrationResource", &auditmanager.AccountRegistrationArgs{
	DelegatedAdminAccount: pulumi.String("string"),
	DeregisterOnDestroy:   pulumi.Bool(false),
	KmsKey:                pulumi.String("string"),
})

    var accountRegistrationResource = new AccountRegistration("accountRegistrationResource", AccountRegistrationArgs.builder()
    .delegatedAdminAccount("string")
    .deregisterOnDestroy(false)
    .kmsKey("string")
    .build());

    account_registration_resource = aws.auditmanager.AccountRegistration("accountRegistrationResource",
    delegated_admin_account="string",
    deregister_on_destroy=False,
    kms_key="string")

    const accountRegistrationResource = new aws.auditmanager.AccountRegistration("accountRegistrationResource", {
    delegatedAdminAccount: "string",
    deregisterOnDestroy: false,
    kmsKey: "string",
});

    type: aws:auditmanager:AccountRegistration
properties:
    delegatedAdminAccount: string
    deregisterOnDestroy: false
    kmsKey: string

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

    DelegatedAdminAccount string
    Identifier for the delegated administrator account.
    DeregisterOnDestroy bool
    Flag to deregister AuditManager in the account upon destruction. Defaults to false (ie. AuditManager will remain active in the account, even if this resource is removed).
    KmsKey string
    KMS key identifier.
    DelegatedAdminAccount string
    Identifier for the delegated administrator account.
    DeregisterOnDestroy bool
    Flag to deregister AuditManager in the account upon destruction. Defaults to false (ie. AuditManager will remain active in the account, even if this resource is removed).
    KmsKey string
    KMS key identifier.
    delegatedAdminAccount String
    Identifier for the delegated administrator account.
    deregisterOnDestroy Boolean
    Flag to deregister AuditManager in the account upon destruction. Defaults to false (ie. AuditManager will remain active in the account, even if this resource is removed).
    kmsKey String
    KMS key identifier.
    delegatedAdminAccount string
    Identifier for the delegated administrator account.
    deregisterOnDestroy boolean
    Flag to deregister AuditManager in the account upon destruction. Defaults to false (ie. AuditManager will remain active in the account, even if this resource is removed).
    kmsKey string
    KMS key identifier.
    delegated_admin_account str
    Identifier for the delegated administrator account.
    deregister_on_destroy bool
    Flag to deregister AuditManager in the account upon destruction. Defaults to false (ie. AuditManager will remain active in the account, even if this resource is removed).
    kms_key str
    KMS key identifier.
    delegatedAdminAccount String
    Identifier for the delegated administrator account.
    deregisterOnDestroy Boolean
    Flag to deregister AuditManager in the account upon destruction. Defaults to false (ie. AuditManager will remain active in the account, even if this resource is removed).
    kmsKey String
    KMS key identifier.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    Status of the account registration request.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    Status of the account registration request.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    Status of the account registration request.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    Status of the account registration request.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    Status of the account registration request.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    Status of the account registration request.

    Look up Existing AccountRegistration Resource

    Get an existing AccountRegistration 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?: AccountRegistrationState, opts?: CustomResourceOptions): AccountRegistration
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        delegated_admin_account: Optional[str] = None,
        deregister_on_destroy: Optional[bool] = None,
        kms_key: Optional[str] = None,
        status: Optional[str] = None) -> AccountRegistration
    func GetAccountRegistration(ctx *Context, name string, id IDInput, state *AccountRegistrationState, opts ...ResourceOption) (*AccountRegistration, error)
    public static AccountRegistration Get(string name, Input<string> id, AccountRegistrationState? state, CustomResourceOptions? opts = null)
    public static AccountRegistration get(String name, Output<String> id, AccountRegistrationState 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.
    The following state arguments are supported:
    DelegatedAdminAccount string
    Identifier for the delegated administrator account.
    DeregisterOnDestroy bool
    Flag to deregister AuditManager in the account upon destruction. Defaults to false (ie. AuditManager will remain active in the account, even if this resource is removed).
    KmsKey string
    KMS key identifier.
    Status string
    Status of the account registration request.
    DelegatedAdminAccount string
    Identifier for the delegated administrator account.
    DeregisterOnDestroy bool
    Flag to deregister AuditManager in the account upon destruction. Defaults to false (ie. AuditManager will remain active in the account, even if this resource is removed).
    KmsKey string
    KMS key identifier.
    Status string
    Status of the account registration request.
    delegatedAdminAccount String
    Identifier for the delegated administrator account.
    deregisterOnDestroy Boolean
    Flag to deregister AuditManager in the account upon destruction. Defaults to false (ie. AuditManager will remain active in the account, even if this resource is removed).
    kmsKey String
    KMS key identifier.
    status String
    Status of the account registration request.
    delegatedAdminAccount string
    Identifier for the delegated administrator account.
    deregisterOnDestroy boolean
    Flag to deregister AuditManager in the account upon destruction. Defaults to false (ie. AuditManager will remain active in the account, even if this resource is removed).
    kmsKey string
    KMS key identifier.
    status string
    Status of the account registration request.
    delegated_admin_account str
    Identifier for the delegated administrator account.
    deregister_on_destroy bool
    Flag to deregister AuditManager in the account upon destruction. Defaults to false (ie. AuditManager will remain active in the account, even if this resource is removed).
    kms_key str
    KMS key identifier.
    status str
    Status of the account registration request.
    delegatedAdminAccount String
    Identifier for the delegated administrator account.
    deregisterOnDestroy Boolean
    Flag to deregister AuditManager in the account upon destruction. Defaults to false (ie. AuditManager will remain active in the account, even if this resource is removed).
    kmsKey String
    KMS key identifier.
    status String
    Status of the account registration request.

    Import

    Using pulumi import, import Audit Manager Account Registration resources using the id. For example:

    $ pulumi import aws:auditmanager/accountRegistration:AccountRegistration example us-east-1

    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.
    aws logo
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-aws