1. Packages
  2. AWS Classic
  3. API Docs
  4. cfg
  5. RecorderStatus

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.31.0 published on Monday, Apr 15, 2024 by Pulumi

aws.cfg.RecorderStatus

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.31.0 published on Monday, Apr 15, 2024 by Pulumi

    Manages status (recording / stopped) of an AWS Config Configuration Recorder.

    Note: Starting Configuration Recorder requires a Delivery Channel to be present. Use of depends_on (as shown below) is recommended to avoid race conditions.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const b = new aws.s3.BucketV2("b", {bucket: "awsconfig-example"});
    const fooDeliveryChannel = new aws.cfg.DeliveryChannel("foo", {
        name: "example",
        s3BucketName: b.bucket,
    });
    const assumeRole = aws.iam.getPolicyDocument({
        statements: [{
            effect: "Allow",
            principals: [{
                type: "Service",
                identifiers: ["config.amazonaws.com"],
            }],
            actions: ["sts:AssumeRole"],
        }],
    });
    const r = new aws.iam.Role("r", {
        name: "example-awsconfig",
        assumeRolePolicy: assumeRole.then(assumeRole => assumeRole.json),
    });
    const fooRecorder = new aws.cfg.Recorder("foo", {
        name: "example",
        roleArn: r.arn,
    });
    const foo = new aws.cfg.RecorderStatus("foo", {
        name: fooRecorder.name,
        isEnabled: true,
    }, {
        dependsOn: [fooDeliveryChannel],
    });
    const a = new aws.iam.RolePolicyAttachment("a", {
        role: r.name,
        policyArn: "arn:aws:iam::aws:policy/service-role/AWS_ConfigRole",
    });
    const p = aws.iam.getPolicyDocumentOutput({
        statements: [{
            effect: "Allow",
            actions: ["s3:*"],
            resources: [
                b.arn,
                pulumi.interpolate`${b.arn}/*`,
            ],
        }],
    });
    const pRolePolicy = new aws.iam.RolePolicy("p", {
        name: "awsconfig-example",
        role: r.id,
        policy: p.apply(p => p.json),
    });
    
    import pulumi
    import pulumi_aws as aws
    
    b = aws.s3.BucketV2("b", bucket="awsconfig-example")
    foo_delivery_channel = aws.cfg.DeliveryChannel("foo",
        name="example",
        s3_bucket_name=b.bucket)
    assume_role = aws.iam.get_policy_document(statements=[aws.iam.GetPolicyDocumentStatementArgs(
        effect="Allow",
        principals=[aws.iam.GetPolicyDocumentStatementPrincipalArgs(
            type="Service",
            identifiers=["config.amazonaws.com"],
        )],
        actions=["sts:AssumeRole"],
    )])
    r = aws.iam.Role("r",
        name="example-awsconfig",
        assume_role_policy=assume_role.json)
    foo_recorder = aws.cfg.Recorder("foo",
        name="example",
        role_arn=r.arn)
    foo = aws.cfg.RecorderStatus("foo",
        name=foo_recorder.name,
        is_enabled=True,
        opts=pulumi.ResourceOptions(depends_on=[foo_delivery_channel]))
    a = aws.iam.RolePolicyAttachment("a",
        role=r.name,
        policy_arn="arn:aws:iam::aws:policy/service-role/AWS_ConfigRole")
    p = aws.iam.get_policy_document_output(statements=[aws.iam.GetPolicyDocumentStatementArgs(
        effect="Allow",
        actions=["s3:*"],
        resources=[
            b.arn,
            b.arn.apply(lambda arn: f"{arn}/*"),
        ],
    )])
    p_role_policy = aws.iam.RolePolicy("p",
        name="awsconfig-example",
        role=r.id,
        policy=p.json)
    
    package main
    
    import (
    	"fmt"
    
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/cfg"
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/iam"
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/s3"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		b, err := s3.NewBucketV2(ctx, "b", &s3.BucketV2Args{
    			Bucket: pulumi.String("awsconfig-example"),
    		})
    		if err != nil {
    			return err
    		}
    		fooDeliveryChannel, err := cfg.NewDeliveryChannel(ctx, "foo", &cfg.DeliveryChannelArgs{
    			Name:         pulumi.String("example"),
    			S3BucketName: b.Bucket,
    		})
    		if err != nil {
    			return err
    		}
    		assumeRole, err := iam.GetPolicyDocument(ctx, &iam.GetPolicyDocumentArgs{
    			Statements: []iam.GetPolicyDocumentStatement{
    				{
    					Effect: pulumi.StringRef("Allow"),
    					Principals: []iam.GetPolicyDocumentStatementPrincipal{
    						{
    							Type: "Service",
    							Identifiers: []string{
    								"config.amazonaws.com",
    							},
    						},
    					},
    					Actions: []string{
    						"sts:AssumeRole",
    					},
    				},
    			},
    		}, nil)
    		if err != nil {
    			return err
    		}
    		r, err := iam.NewRole(ctx, "r", &iam.RoleArgs{
    			Name:             pulumi.String("example-awsconfig"),
    			AssumeRolePolicy: pulumi.String(assumeRole.Json),
    		})
    		if err != nil {
    			return err
    		}
    		fooRecorder, err := cfg.NewRecorder(ctx, "foo", &cfg.RecorderArgs{
    			Name:    pulumi.String("example"),
    			RoleArn: r.Arn,
    		})
    		if err != nil {
    			return err
    		}
    		_, err = cfg.NewRecorderStatus(ctx, "foo", &cfg.RecorderStatusArgs{
    			Name:      fooRecorder.Name,
    			IsEnabled: pulumi.Bool(true),
    		}, pulumi.DependsOn([]pulumi.Resource{
    			fooDeliveryChannel,
    		}))
    		if err != nil {
    			return err
    		}
    		_, err = iam.NewRolePolicyAttachment(ctx, "a", &iam.RolePolicyAttachmentArgs{
    			Role:      r.Name,
    			PolicyArn: pulumi.String("arn:aws:iam::aws:policy/service-role/AWS_ConfigRole"),
    		})
    		if err != nil {
    			return err
    		}
    		p := iam.GetPolicyDocumentOutput(ctx, iam.GetPolicyDocumentOutputArgs{
    			Statements: iam.GetPolicyDocumentStatementArray{
    				&iam.GetPolicyDocumentStatementArgs{
    					Effect: pulumi.String("Allow"),
    					Actions: pulumi.StringArray{
    						pulumi.String("s3:*"),
    					},
    					Resources: pulumi.StringArray{
    						b.Arn,
    						b.Arn.ApplyT(func(arn string) (string, error) {
    							return fmt.Sprintf("%v/*", arn), nil
    						}).(pulumi.StringOutput),
    					},
    				},
    			},
    		}, nil)
    		_, err = iam.NewRolePolicy(ctx, "p", &iam.RolePolicyArgs{
    			Name: pulumi.String("awsconfig-example"),
    			Role: r.ID(),
    			Policy: p.ApplyT(func(p iam.GetPolicyDocumentResult) (*string, error) {
    				return &p.Json, nil
    			}).(pulumi.StringPtrOutput),
    		})
    		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 b = new Aws.S3.BucketV2("b", new()
        {
            Bucket = "awsconfig-example",
        });
    
        var fooDeliveryChannel = new Aws.Cfg.DeliveryChannel("foo", new()
        {
            Name = "example",
            S3BucketName = b.Bucket,
        });
    
        var assumeRole = Aws.Iam.GetPolicyDocument.Invoke(new()
        {
            Statements = new[]
            {
                new Aws.Iam.Inputs.GetPolicyDocumentStatementInputArgs
                {
                    Effect = "Allow",
                    Principals = new[]
                    {
                        new Aws.Iam.Inputs.GetPolicyDocumentStatementPrincipalInputArgs
                        {
                            Type = "Service",
                            Identifiers = new[]
                            {
                                "config.amazonaws.com",
                            },
                        },
                    },
                    Actions = new[]
                    {
                        "sts:AssumeRole",
                    },
                },
            },
        });
    
        var r = new Aws.Iam.Role("r", new()
        {
            Name = "example-awsconfig",
            AssumeRolePolicy = assumeRole.Apply(getPolicyDocumentResult => getPolicyDocumentResult.Json),
        });
    
        var fooRecorder = new Aws.Cfg.Recorder("foo", new()
        {
            Name = "example",
            RoleArn = r.Arn,
        });
    
        var foo = new Aws.Cfg.RecorderStatus("foo", new()
        {
            Name = fooRecorder.Name,
            IsEnabled = true,
        }, new CustomResourceOptions
        {
            DependsOn =
            {
                fooDeliveryChannel, 
            },
        });
    
        var a = new Aws.Iam.RolePolicyAttachment("a", new()
        {
            Role = r.Name,
            PolicyArn = "arn:aws:iam::aws:policy/service-role/AWS_ConfigRole",
        });
    
        var p = Aws.Iam.GetPolicyDocument.Invoke(new()
        {
            Statements = new[]
            {
                new Aws.Iam.Inputs.GetPolicyDocumentStatementInputArgs
                {
                    Effect = "Allow",
                    Actions = new[]
                    {
                        "s3:*",
                    },
                    Resources = new[]
                    {
                        b.Arn,
                        $"{b.Arn}/*",
                    },
                },
            },
        });
    
        var pRolePolicy = new Aws.Iam.RolePolicy("p", new()
        {
            Name = "awsconfig-example",
            Role = r.Id,
            Policy = p.Apply(getPolicyDocumentResult => getPolicyDocumentResult.Json),
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.s3.BucketV2;
    import com.pulumi.aws.s3.BucketV2Args;
    import com.pulumi.aws.cfg.DeliveryChannel;
    import com.pulumi.aws.cfg.DeliveryChannelArgs;
    import com.pulumi.aws.iam.IamFunctions;
    import com.pulumi.aws.iam.inputs.GetPolicyDocumentArgs;
    import com.pulumi.aws.iam.Role;
    import com.pulumi.aws.iam.RoleArgs;
    import com.pulumi.aws.cfg.Recorder;
    import com.pulumi.aws.cfg.RecorderArgs;
    import com.pulumi.aws.cfg.RecorderStatus;
    import com.pulumi.aws.cfg.RecorderStatusArgs;
    import com.pulumi.aws.iam.RolePolicyAttachment;
    import com.pulumi.aws.iam.RolePolicyAttachmentArgs;
    import com.pulumi.aws.iam.RolePolicy;
    import com.pulumi.aws.iam.RolePolicyArgs;
    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 b = new BucketV2("b", BucketV2Args.builder()        
                .bucket("awsconfig-example")
                .build());
    
            var fooDeliveryChannel = new DeliveryChannel("fooDeliveryChannel", DeliveryChannelArgs.builder()        
                .name("example")
                .s3BucketName(b.bucket())
                .build());
    
            final var assumeRole = IamFunctions.getPolicyDocument(GetPolicyDocumentArgs.builder()
                .statements(GetPolicyDocumentStatementArgs.builder()
                    .effect("Allow")
                    .principals(GetPolicyDocumentStatementPrincipalArgs.builder()
                        .type("Service")
                        .identifiers("config.amazonaws.com")
                        .build())
                    .actions("sts:AssumeRole")
                    .build())
                .build());
    
            var r = new Role("r", RoleArgs.builder()        
                .name("example-awsconfig")
                .assumeRolePolicy(assumeRole.applyValue(getPolicyDocumentResult -> getPolicyDocumentResult.json()))
                .build());
    
            var fooRecorder = new Recorder("fooRecorder", RecorderArgs.builder()        
                .name("example")
                .roleArn(r.arn())
                .build());
    
            var foo = new RecorderStatus("foo", RecorderStatusArgs.builder()        
                .name(fooRecorder.name())
                .isEnabled(true)
                .build(), CustomResourceOptions.builder()
                    .dependsOn(fooDeliveryChannel)
                    .build());
    
            var a = new RolePolicyAttachment("a", RolePolicyAttachmentArgs.builder()        
                .role(r.name())
                .policyArn("arn:aws:iam::aws:policy/service-role/AWS_ConfigRole")
                .build());
    
            final var p = IamFunctions.getPolicyDocument(GetPolicyDocumentArgs.builder()
                .statements(GetPolicyDocumentStatementArgs.builder()
                    .effect("Allow")
                    .actions("s3:*")
                    .resources(                
                        b.arn(),
                        b.arn().applyValue(arn -> String.format("%s/*", arn)))
                    .build())
                .build());
    
            var pRolePolicy = new RolePolicy("pRolePolicy", RolePolicyArgs.builder()        
                .name("awsconfig-example")
                .role(r.id())
                .policy(p.applyValue(getPolicyDocumentResult -> getPolicyDocumentResult).applyValue(p -> p.applyValue(getPolicyDocumentResult -> getPolicyDocumentResult.json())))
                .build());
    
        }
    }
    
    resources:
      foo:
        type: aws:cfg:RecorderStatus
        properties:
          name: ${fooRecorder.name}
          isEnabled: true
        options:
          dependson:
            - ${fooDeliveryChannel}
      a:
        type: aws:iam:RolePolicyAttachment
        properties:
          role: ${r.name}
          policyArn: arn:aws:iam::aws:policy/service-role/AWS_ConfigRole
      b:
        type: aws:s3:BucketV2
        properties:
          bucket: awsconfig-example
      fooDeliveryChannel:
        type: aws:cfg:DeliveryChannel
        name: foo
        properties:
          name: example
          s3BucketName: ${b.bucket}
      fooRecorder:
        type: aws:cfg:Recorder
        name: foo
        properties:
          name: example
          roleArn: ${r.arn}
      r:
        type: aws:iam:Role
        properties:
          name: example-awsconfig
          assumeRolePolicy: ${assumeRole.json}
      pRolePolicy:
        type: aws:iam:RolePolicy
        name: p
        properties:
          name: awsconfig-example
          role: ${r.id}
          policy: ${p.json}
    variables:
      assumeRole:
        fn::invoke:
          Function: aws:iam:getPolicyDocument
          Arguments:
            statements:
              - effect: Allow
                principals:
                  - type: Service
                    identifiers:
                      - config.amazonaws.com
                actions:
                  - sts:AssumeRole
      p:
        fn::invoke:
          Function: aws:iam:getPolicyDocument
          Arguments:
            statements:
              - effect: Allow
                actions:
                  - s3:*
                resources:
                  - ${b.arn}
                  - ${b.arn}/*
    

    Create RecorderStatus Resource

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

    Constructor syntax

    new RecorderStatus(name: string, args: RecorderStatusArgs, opts?: CustomResourceOptions);
    @overload
    def RecorderStatus(resource_name: str,
                       args: RecorderStatusArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def RecorderStatus(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       is_enabled: Optional[bool] = None,
                       name: Optional[str] = None)
    func NewRecorderStatus(ctx *Context, name string, args RecorderStatusArgs, opts ...ResourceOption) (*RecorderStatus, error)
    public RecorderStatus(string name, RecorderStatusArgs args, CustomResourceOptions? opts = null)
    public RecorderStatus(String name, RecorderStatusArgs args)
    public RecorderStatus(String name, RecorderStatusArgs args, CustomResourceOptions options)
    
    type: aws:cfg:RecorderStatus
    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 RecorderStatusArgs
    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 RecorderStatusArgs
    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 RecorderStatusArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RecorderStatusArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RecorderStatusArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var recorderStatusResource = new Aws.Cfg.RecorderStatus("recorderStatusResource", new()
    {
        IsEnabled = false,
        Name = "string",
    });
    
    example, err := cfg.NewRecorderStatus(ctx, "recorderStatusResource", &cfg.RecorderStatusArgs{
    	IsEnabled: pulumi.Bool(false),
    	Name:      pulumi.String("string"),
    })
    
    var recorderStatusResource = new RecorderStatus("recorderStatusResource", RecorderStatusArgs.builder()        
        .isEnabled(false)
        .name("string")
        .build());
    
    recorder_status_resource = aws.cfg.RecorderStatus("recorderStatusResource",
        is_enabled=False,
        name="string")
    
    const recorderStatusResource = new aws.cfg.RecorderStatus("recorderStatusResource", {
        isEnabled: false,
        name: "string",
    });
    
    type: aws:cfg:RecorderStatus
    properties:
        isEnabled: false
        name: string
    

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

    IsEnabled bool
    Whether the configuration recorder should be enabled or disabled.
    Name string
    The name of the recorder
    IsEnabled bool
    Whether the configuration recorder should be enabled or disabled.
    Name string
    The name of the recorder
    isEnabled Boolean
    Whether the configuration recorder should be enabled or disabled.
    name String
    The name of the recorder
    isEnabled boolean
    Whether the configuration recorder should be enabled or disabled.
    name string
    The name of the recorder
    is_enabled bool
    Whether the configuration recorder should be enabled or disabled.
    name str
    The name of the recorder
    isEnabled Boolean
    Whether the configuration recorder should be enabled or disabled.
    name String
    The name of the recorder

    Outputs

    All input properties are implicitly available as output properties. Additionally, the RecorderStatus 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 RecorderStatus Resource

    Get an existing RecorderStatus 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?: RecorderStatusState, opts?: CustomResourceOptions): RecorderStatus
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            is_enabled: Optional[bool] = None,
            name: Optional[str] = None) -> RecorderStatus
    func GetRecorderStatus(ctx *Context, name string, id IDInput, state *RecorderStatusState, opts ...ResourceOption) (*RecorderStatus, error)
    public static RecorderStatus Get(string name, Input<string> id, RecorderStatusState? state, CustomResourceOptions? opts = null)
    public static RecorderStatus get(String name, Output<String> id, RecorderStatusState 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:
    IsEnabled bool
    Whether the configuration recorder should be enabled or disabled.
    Name string
    The name of the recorder
    IsEnabled bool
    Whether the configuration recorder should be enabled or disabled.
    Name string
    The name of the recorder
    isEnabled Boolean
    Whether the configuration recorder should be enabled or disabled.
    name String
    The name of the recorder
    isEnabled boolean
    Whether the configuration recorder should be enabled or disabled.
    name string
    The name of the recorder
    is_enabled bool
    Whether the configuration recorder should be enabled or disabled.
    name str
    The name of the recorder
    isEnabled Boolean
    Whether the configuration recorder should be enabled or disabled.
    name String
    The name of the recorder

    Import

    Using pulumi import, import Configuration Recorder Status using the name of the Configuration Recorder. For example:

    $ pulumi import aws:cfg/recorderStatus:RecorderStatus foo example
    

    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

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.31.0 published on Monday, Apr 15, 2024 by Pulumi