Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. directoryservice
  5. LogSubscription
AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws

aws.directoryservice.LogSubscription

Explore with Pulumi AI

AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws

Provides a Log subscription for AWS Directory Service that pushes logs to cloudwatch.

Example Usage

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

const example = new aws.cloudwatch.LogGroup("example", {
    name: `/aws/directoryservice/${exampleAwsDirectoryServiceDirectory.id}`,
    retentionInDays: 14,
});
const ad_log_policy = aws.iam.getPolicyDocumentOutput({
    statements: [{
        actions: [
            "logs:CreateLogStream",
            "logs:PutLogEvents",
        ],
        principals: [{
            identifiers: ["ds.amazonaws.com"],
            type: "Service",
        }],
        resources: [pulumi.interpolate`${example.arn}:*`],
        effect: "Allow",
    }],
});
const ad_log_policyLogResourcePolicy = new aws.cloudwatch.LogResourcePolicy("ad-log-policy", {
    policyDocument: ad_log_policy.apply(ad_log_policy => ad_log_policy.json),
    policyName: "ad-log-policy",
});
const exampleLogSubscription = new aws.directoryservice.LogSubscription("example", {
    directoryId: exampleAwsDirectoryServiceDirectory.id,
    logGroupName: example.name,
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.cloudwatch.LogGroup("example",
    name=f"/aws/directoryservice/{example_aws_directory_service_directory['id']}",
    retention_in_days=14)
ad_log_policy = aws.iam.get_policy_document_output(statements=[{
    "actions": [
        "logs:CreateLogStream",
        "logs:PutLogEvents",
    ],
    "principals": [{
        "identifiers": ["ds.amazonaws.com"],
        "type": "Service",
    }],
    "resources": [example.arn.apply(lambda arn: f"{arn}:*")],
    "effect": "Allow",
}])
ad_log_policy_log_resource_policy = aws.cloudwatch.LogResourcePolicy("ad-log-policy",
    policy_document=ad_log_policy.json,
    policy_name="ad-log-policy")
example_log_subscription = aws.directoryservice.LogSubscription("example",
    directory_id=example_aws_directory_service_directory["id"],
    log_group_name=example.name)
Copy
package main

import (
	"fmt"

	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/cloudwatch"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/directoryservice"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/iam"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := cloudwatch.NewLogGroup(ctx, "example", &cloudwatch.LogGroupArgs{
			Name:            pulumi.Sprintf("/aws/directoryservice/%v", exampleAwsDirectoryServiceDirectory.Id),
			RetentionInDays: pulumi.Int(14),
		})
		if err != nil {
			return err
		}
		ad_log_policy := iam.GetPolicyDocumentOutput(ctx, iam.GetPolicyDocumentOutputArgs{
			Statements: iam.GetPolicyDocumentStatementArray{
				&iam.GetPolicyDocumentStatementArgs{
					Actions: pulumi.StringArray{
						pulumi.String("logs:CreateLogStream"),
						pulumi.String("logs:PutLogEvents"),
					},
					Principals: iam.GetPolicyDocumentStatementPrincipalArray{
						&iam.GetPolicyDocumentStatementPrincipalArgs{
							Identifiers: pulumi.StringArray{
								pulumi.String("ds.amazonaws.com"),
							},
							Type: pulumi.String("Service"),
						},
					},
					Resources: pulumi.StringArray{
						example.Arn.ApplyT(func(arn string) (string, error) {
							return fmt.Sprintf("%v:*", arn), nil
						}).(pulumi.StringOutput),
					},
					Effect: pulumi.String("Allow"),
				},
			},
		}, nil)
		_, err = cloudwatch.NewLogResourcePolicy(ctx, "ad-log-policy", &cloudwatch.LogResourcePolicyArgs{
			PolicyDocument: pulumi.String(ad_log_policy.ApplyT(func(ad_log_policy iam.GetPolicyDocumentResult) (*string, error) {
				return &ad_log_policy.Json, nil
			}).(pulumi.StringPtrOutput)),
			PolicyName: pulumi.String("ad-log-policy"),
		})
		if err != nil {
			return err
		}
		_, err = directoryservice.NewLogSubscription(ctx, "example", &directoryservice.LogSubscriptionArgs{
			DirectoryId:  pulumi.Any(exampleAwsDirectoryServiceDirectory.Id),
			LogGroupName: example.Name,
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.CloudWatch.LogGroup("example", new()
    {
        Name = $"/aws/directoryservice/{exampleAwsDirectoryServiceDirectory.Id}",
        RetentionInDays = 14,
    });

    var ad_log_policy = Aws.Iam.GetPolicyDocument.Invoke(new()
    {
        Statements = new[]
        {
            new Aws.Iam.Inputs.GetPolicyDocumentStatementInputArgs
            {
                Actions = new[]
                {
                    "logs:CreateLogStream",
                    "logs:PutLogEvents",
                },
                Principals = new[]
                {
                    new Aws.Iam.Inputs.GetPolicyDocumentStatementPrincipalInputArgs
                    {
                        Identifiers = new[]
                        {
                            "ds.amazonaws.com",
                        },
                        Type = "Service",
                    },
                },
                Resources = new[]
                {
                    $"{example.Arn}:*",
                },
                Effect = "Allow",
            },
        },
    });

    var ad_log_policyLogResourcePolicy = new Aws.CloudWatch.LogResourcePolicy("ad-log-policy", new()
    {
        PolicyDocument = ad_log_policy.Apply(ad_log_policy => ad_log_policy.Apply(getPolicyDocumentResult => getPolicyDocumentResult.Json)),
        PolicyName = "ad-log-policy",
    });

    var exampleLogSubscription = new Aws.DirectoryService.LogSubscription("example", new()
    {
        DirectoryId = exampleAwsDirectoryServiceDirectory.Id,
        LogGroupName = example.Name,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.cloudwatch.LogGroup;
import com.pulumi.aws.cloudwatch.LogGroupArgs;
import com.pulumi.aws.iam.IamFunctions;
import com.pulumi.aws.iam.inputs.GetPolicyDocumentArgs;
import com.pulumi.aws.cloudwatch.LogResourcePolicy;
import com.pulumi.aws.cloudwatch.LogResourcePolicyArgs;
import com.pulumi.aws.directoryservice.LogSubscription;
import com.pulumi.aws.directoryservice.LogSubscriptionArgs;
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 LogGroup("example", LogGroupArgs.builder()
            .name(String.format("/aws/directoryservice/%s", exampleAwsDirectoryServiceDirectory.id()))
            .retentionInDays(14)
            .build());

        final var ad-log-policy = IamFunctions.getPolicyDocument(GetPolicyDocumentArgs.builder()
            .statements(GetPolicyDocumentStatementArgs.builder()
                .actions(                
                    "logs:CreateLogStream",
                    "logs:PutLogEvents")
                .principals(GetPolicyDocumentStatementPrincipalArgs.builder()
                    .identifiers("ds.amazonaws.com")
                    .type("Service")
                    .build())
                .resources(example.arn().applyValue(arn -> String.format("%s:*", arn)))
                .effect("Allow")
                .build())
            .build());

        var ad_log_policyLogResourcePolicy = new LogResourcePolicy("ad-log-policyLogResourcePolicy", LogResourcePolicyArgs.builder()
            .policyDocument(ad_log_policy.applyValue(ad_log_policy -> ad_log_policy.json()))
            .policyName("ad-log-policy")
            .build());

        var exampleLogSubscription = new LogSubscription("exampleLogSubscription", LogSubscriptionArgs.builder()
            .directoryId(exampleAwsDirectoryServiceDirectory.id())
            .logGroupName(example.name())
            .build());

    }
}
Copy
resources:
  example:
    type: aws:cloudwatch:LogGroup
    properties:
      name: /aws/directoryservice/${exampleAwsDirectoryServiceDirectory.id}
      retentionInDays: 14
  ad-log-policyLogResourcePolicy:
    type: aws:cloudwatch:LogResourcePolicy
    name: ad-log-policy
    properties:
      policyDocument: ${["ad-log-policy"].json}
      policyName: ad-log-policy
  exampleLogSubscription:
    type: aws:directoryservice:LogSubscription
    name: example
    properties:
      directoryId: ${exampleAwsDirectoryServiceDirectory.id}
      logGroupName: ${example.name}
variables:
  ad-log-policy:
    fn::invoke:
      function: aws:iam:getPolicyDocument
      arguments:
        statements:
          - actions:
              - logs:CreateLogStream
              - logs:PutLogEvents
            principals:
              - identifiers:
                  - ds.amazonaws.com
                type: Service
            resources:
              - ${example.arn}:*
            effect: Allow
Copy

Create LogSubscription Resource

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

Constructor syntax

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

@overload
def LogSubscription(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    directory_id: Optional[str] = None,
                    log_group_name: Optional[str] = None)
func NewLogSubscription(ctx *Context, name string, args LogSubscriptionArgs, opts ...ResourceOption) (*LogSubscription, error)
public LogSubscription(string name, LogSubscriptionArgs args, CustomResourceOptions? opts = null)
public LogSubscription(String name, LogSubscriptionArgs args)
public LogSubscription(String name, LogSubscriptionArgs args, CustomResourceOptions options)

type: aws:directoryservice:LogSubscription
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. LogSubscriptionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. LogSubscriptionArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. LogSubscriptionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. LogSubscriptionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. LogSubscriptionArgs
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 logSubscriptionResource = new Aws.DirectoryService.LogSubscription("logSubscriptionResource", new()
{
    DirectoryId = "string",
    LogGroupName = "string",
});
Copy
example, err := directoryservice.NewLogSubscription(ctx, "logSubscriptionResource", &directoryservice.LogSubscriptionArgs{
	DirectoryId:  pulumi.String("string"),
	LogGroupName: pulumi.String("string"),
})
Copy
var logSubscriptionResource = new LogSubscription("logSubscriptionResource", LogSubscriptionArgs.builder()
    .directoryId("string")
    .logGroupName("string")
    .build());
Copy
log_subscription_resource = aws.directoryservice.LogSubscription("logSubscriptionResource",
    directory_id="string",
    log_group_name="string")
Copy
const logSubscriptionResource = new aws.directoryservice.LogSubscription("logSubscriptionResource", {
    directoryId: "string",
    logGroupName: "string",
});
Copy
type: aws:directoryservice:LogSubscription
properties:
    directoryId: string
    logGroupName: string
Copy

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

DirectoryId
This property is required.
Changes to this property will trigger replacement.
string
ID of directory.
LogGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the cloudwatch log group to which the logs should be published. The log group should be already created and the directory service principal should be provided with required permission to create stream and publish logs. Changing this value would delete the current subscription and create a new one. A directory can only have one log subscription at a time.
DirectoryId
This property is required.
Changes to this property will trigger replacement.
string
ID of directory.
LogGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the cloudwatch log group to which the logs should be published. The log group should be already created and the directory service principal should be provided with required permission to create stream and publish logs. Changing this value would delete the current subscription and create a new one. A directory can only have one log subscription at a time.
directoryId
This property is required.
Changes to this property will trigger replacement.
String
ID of directory.
logGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the cloudwatch log group to which the logs should be published. The log group should be already created and the directory service principal should be provided with required permission to create stream and publish logs. Changing this value would delete the current subscription and create a new one. A directory can only have one log subscription at a time.
directoryId
This property is required.
Changes to this property will trigger replacement.
string
ID of directory.
logGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the cloudwatch log group to which the logs should be published. The log group should be already created and the directory service principal should be provided with required permission to create stream and publish logs. Changing this value would delete the current subscription and create a new one. A directory can only have one log subscription at a time.
directory_id
This property is required.
Changes to this property will trigger replacement.
str
ID of directory.
log_group_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the cloudwatch log group to which the logs should be published. The log group should be already created and the directory service principal should be provided with required permission to create stream and publish logs. Changing this value would delete the current subscription and create a new one. A directory can only have one log subscription at a time.
directoryId
This property is required.
Changes to this property will trigger replacement.
String
ID of directory.
logGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the cloudwatch log group to which the logs should be published. The log group should be already created and the directory service principal should be provided with required permission to create stream and publish logs. Changing this value would delete the current subscription and create a new one. A directory can only have one log subscription at a time.

Outputs

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

Get an existing LogSubscription 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?: LogSubscriptionState, opts?: CustomResourceOptions): LogSubscription
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        directory_id: Optional[str] = None,
        log_group_name: Optional[str] = None) -> LogSubscription
func GetLogSubscription(ctx *Context, name string, id IDInput, state *LogSubscriptionState, opts ...ResourceOption) (*LogSubscription, error)
public static LogSubscription Get(string name, Input<string> id, LogSubscriptionState? state, CustomResourceOptions? opts = null)
public static LogSubscription get(String name, Output<String> id, LogSubscriptionState state, CustomResourceOptions options)
resources:  _:    type: aws:directoryservice:LogSubscription    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
DirectoryId Changes to this property will trigger replacement. string
ID of directory.
LogGroupName Changes to this property will trigger replacement. string
Name of the cloudwatch log group to which the logs should be published. The log group should be already created and the directory service principal should be provided with required permission to create stream and publish logs. Changing this value would delete the current subscription and create a new one. A directory can only have one log subscription at a time.
DirectoryId Changes to this property will trigger replacement. string
ID of directory.
LogGroupName Changes to this property will trigger replacement. string
Name of the cloudwatch log group to which the logs should be published. The log group should be already created and the directory service principal should be provided with required permission to create stream and publish logs. Changing this value would delete the current subscription and create a new one. A directory can only have one log subscription at a time.
directoryId Changes to this property will trigger replacement. String
ID of directory.
logGroupName Changes to this property will trigger replacement. String
Name of the cloudwatch log group to which the logs should be published. The log group should be already created and the directory service principal should be provided with required permission to create stream and publish logs. Changing this value would delete the current subscription and create a new one. A directory can only have one log subscription at a time.
directoryId Changes to this property will trigger replacement. string
ID of directory.
logGroupName Changes to this property will trigger replacement. string
Name of the cloudwatch log group to which the logs should be published. The log group should be already created and the directory service principal should be provided with required permission to create stream and publish logs. Changing this value would delete the current subscription and create a new one. A directory can only have one log subscription at a time.
directory_id Changes to this property will trigger replacement. str
ID of directory.
log_group_name Changes to this property will trigger replacement. str
Name of the cloudwatch log group to which the logs should be published. The log group should be already created and the directory service principal should be provided with required permission to create stream and publish logs. Changing this value would delete the current subscription and create a new one. A directory can only have one log subscription at a time.
directoryId Changes to this property will trigger replacement. String
ID of directory.
logGroupName Changes to this property will trigger replacement. String
Name of the cloudwatch log group to which the logs should be published. The log group should be already created and the directory service principal should be provided with required permission to create stream and publish logs. Changing this value would delete the current subscription and create a new one. A directory can only have one log subscription at a time.

Import

Using pulumi import, import Directory Service Log Subscriptions using the directory id. For example:

$ pulumi import aws:directoryservice/logSubscription:LogSubscription msad d-1234567890
Copy

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 v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws