1. Packages
  2. AWS
  3. API Docs
  4. directoryservice
  5. LogService
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

aws.directoryservice.LogService

Explore with Pulumi AI

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

    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 exampleLogService = new aws.directoryservice.LogService("example", {
        directoryId: exampleAwsDirectoryServiceDirectory.id,
        logGroupName: example.name,
    });
    
    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_service = aws.directoryservice.LogService("example",
        directory_id=example_aws_directory_service_directory["id"],
        log_group_name=example.name)
    
    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.NewLogService(ctx, "example", &directoryservice.LogServiceArgs{
    			DirectoryId:  pulumi.Any(exampleAwsDirectoryServiceDirectory.Id),
    			LogGroupName: example.Name,
    		})
    		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.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 exampleLogService = new Aws.DirectoryService.LogService("example", new()
        {
            DirectoryId = exampleAwsDirectoryServiceDirectory.Id,
            LogGroupName = example.Name,
        });
    
    });
    
    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.LogService;
    import com.pulumi.aws.directoryservice.LogServiceArgs;
    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 exampleLogService = new LogService("exampleLogService", LogServiceArgs.builder()
                .directoryId(exampleAwsDirectoryServiceDirectory.id())
                .logGroupName(example.name())
                .build());
    
        }
    }
    
    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
      exampleLogService:
        type: aws:directoryservice:LogService
        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
    

    Create LogService Resource

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

    Constructor syntax

    new LogService(name: string, args: LogServiceArgs, opts?: CustomResourceOptions);
    @overload
    def LogService(resource_name: str,
                   args: LogServiceArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def LogService(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   directory_id: Optional[str] = None,
                   log_group_name: Optional[str] = None)
    func NewLogService(ctx *Context, name string, args LogServiceArgs, opts ...ResourceOption) (*LogService, error)
    public LogService(string name, LogServiceArgs args, CustomResourceOptions? opts = null)
    public LogService(String name, LogServiceArgs args)
    public LogService(String name, LogServiceArgs args, CustomResourceOptions options)
    
    type: aws:directoryservice:LogService
    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 LogServiceArgs
    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 LogServiceArgs
    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 LogServiceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LogServiceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LogServiceArgs
    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 logServiceResource = new Aws.DirectoryService.LogService("logServiceResource", new()
    {
        DirectoryId = "string",
        LogGroupName = "string",
    });
    
    example, err := directoryservice.NewLogService(ctx, "logServiceResource", &directoryservice.LogServiceArgs{
    	DirectoryId:  pulumi.String("string"),
    	LogGroupName: pulumi.String("string"),
    })
    
    var logServiceResource = new LogService("logServiceResource", LogServiceArgs.builder()
        .directoryId("string")
        .logGroupName("string")
        .build());
    
    log_service_resource = aws.directoryservice.LogService("logServiceResource",
        directory_id="string",
        log_group_name="string")
    
    const logServiceResource = new aws.directoryservice.LogService("logServiceResource", {
        directoryId: "string",
        logGroupName: "string",
    });
    
    type: aws:directoryservice:LogService
    properties:
        directoryId: string
        logGroupName: string
    

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

    DirectoryId string
    ID of directory.
    LogGroupName 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 string
    ID of directory.
    LogGroupName 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 String
    ID of directory.
    logGroupName 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 string
    ID of directory.
    logGroupName 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 str
    ID of directory.
    log_group_name 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 String
    ID of directory.
    logGroupName 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 LogService 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 LogService Resource

    Get an existing LogService 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?: LogServiceState, opts?: CustomResourceOptions): LogService
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            directory_id: Optional[str] = None,
            log_group_name: Optional[str] = None) -> LogService
    func GetLogService(ctx *Context, name string, id IDInput, state *LogServiceState, opts ...ResourceOption) (*LogService, error)
    public static LogService Get(string name, Input<string> id, LogServiceState? state, CustomResourceOptions? opts = null)
    public static LogService get(String name, Output<String> id, LogServiceState 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:
    DirectoryId string
    ID of directory.
    LogGroupName 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 string
    ID of directory.
    LogGroupName 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 String
    ID of directory.
    logGroupName 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 string
    ID of directory.
    logGroupName 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 str
    ID of directory.
    log_group_name 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 String
    ID of directory.
    logGroupName 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/logService:LogService msad d-1234567890
    

    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