Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Sumologic Provider
  3. API Docs
  4. DataForwardingDestination
Sumo Logic v0.23.7 published on Thursday, Oct 24, 2024 by Pulumi
pulumi/pulumi-sumologic

sumologic.DataForwardingDestination

Explore with Pulumi AI

sumologic logo
Sumo Logic v0.23.7 published on Thursday, Oct 24, 2024 by Pulumi
pulumi/pulumi-sumologic

    Provider to manage Sumologic Data Forwarding Destination

    Example Usage

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

const exampleDataForwardingDestination = new sumologic.DataForwardingDestination("example_data_forwarding_destination", {
    destinationName: "df-destination",
    description: "some description",
    bucketName: "df-bucket",
    s3Region: "us-east-1",
    authentication: {
        type: "RoleBased",
        roleArn: "arn:aws:iam::your_arn",
    },
    s3ServerSideEncryption: false,
    enabled: true,
});

    import pulumi
import pulumi_sumologic as sumologic

example_data_forwarding_destination = sumologic.DataForwardingDestination("example_data_forwarding_destination",
    destination_name="df-destination",
    description="some description",
    bucket_name="df-bucket",
    s3_region="us-east-1",
    authentication={
        "type": "RoleBased",
        "role_arn": "arn:aws:iam::your_arn",
    },
    s3_server_side_encryption=False,
    enabled=True)

    package main

import (
	"github.com/pulumi/pulumi-sumologic/sdk/go/sumologic"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sumologic.NewDataForwardingDestination(ctx, "example_data_forwarding_destination", &sumologic.DataForwardingDestinationArgs{
			DestinationName: pulumi.String("df-destination"),
			Description:     pulumi.String("some description"),
			BucketName:      pulumi.String("df-bucket"),
			S3Region:        pulumi.String("us-east-1"),
			Authentication: &sumologic.DataForwardingDestinationAuthenticationArgs{
				Type:    pulumi.String("RoleBased"),
				RoleArn: pulumi.String("arn:aws:iam::your_arn"),
			},
			S3ServerSideEncryption: pulumi.Bool(false),
			Enabled:                pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using SumoLogic = Pulumi.SumoLogic;

return await Deployment.RunAsync(() => 
{
    var exampleDataForwardingDestination = new SumoLogic.DataForwardingDestination("example_data_forwarding_destination", new()
    {
        DestinationName = "df-destination",
        Description = "some description",
        BucketName = "df-bucket",
        S3Region = "us-east-1",
        Authentication = new SumoLogic.Inputs.DataForwardingDestinationAuthenticationArgs
        {
            Type = "RoleBased",
            RoleArn = "arn:aws:iam::your_arn",
        },
        S3ServerSideEncryption = false,
        Enabled = true,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.sumologic.DataForwardingDestination;
import com.pulumi.sumologic.DataForwardingDestinationArgs;
import com.pulumi.sumologic.inputs.DataForwardingDestinationAuthenticationArgs;
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 exampleDataForwardingDestination = new DataForwardingDestination("exampleDataForwardingDestination", DataForwardingDestinationArgs.builder()
            .destinationName("df-destination")
            .description("some description")
            .bucketName("df-bucket")
            .s3Region("us-east-1")
            .authentication(DataForwardingDestinationAuthenticationArgs.builder()
                .type("RoleBased")
                .roleArn("arn:aws:iam::your_arn")
                .build())
            .s3ServerSideEncryption(false)
            .enabled(true)
            .build());

    }
}

    resources:
  exampleDataForwardingDestination:
    type: sumologic:DataForwardingDestination
    name: example_data_forwarding_destination
    properties:
      destinationName: df-destination
      description: some description
      bucketName: df-bucket
      s3Region: us-east-1
      authentication:
        type: RoleBased
        roleArn: arn:aws:iam::your_arn
      s3ServerSideEncryption: false
      enabled: true

    Create DataForwardingDestination Resource

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

    Constructor syntax

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

@overload
def DataForwardingDestination(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              authentication: Optional[DataForwardingDestinationAuthenticationArgs] = None,
                              bucket_name: Optional[str] = None,
                              destination_name: Optional[str] = None,
                              description: Optional[str] = None,
                              enabled: Optional[bool] = None,
                              s3_region: Optional[str] = None,
                              s3_server_side_encryption: Optional[bool] = None)
    func NewDataForwardingDestination(ctx *Context, name string, args DataForwardingDestinationArgs, opts ...ResourceOption) (*DataForwardingDestination, error)
    public DataForwardingDestination(string name, DataForwardingDestinationArgs args, CustomResourceOptions? opts = null)
    public DataForwardingDestination(String name, DataForwardingDestinationArgs args)
public DataForwardingDestination(String name, DataForwardingDestinationArgs args, CustomResourceOptions options)

    type: sumologic:DataForwardingDestination
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 DataForwardingDestinationArgs
    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 DataForwardingDestinationArgs
    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 DataForwardingDestinationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DataForwardingDestinationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DataForwardingDestinationArgs
    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 dataForwardingDestinationResource = new SumoLogic.DataForwardingDestination("dataForwardingDestinationResource", new()
{
    Authentication = new SumoLogic.Inputs.DataForwardingDestinationAuthenticationArgs
    {
        Type = "string",
        AccessKey = "string",
        RoleArn = "string",
        SecretKey = "string",
    },
    BucketName = "string",
    DestinationName = "string",
    Description = "string",
    Enabled = false,
    S3Region = "string",
    S3ServerSideEncryption = false,
});

    example, err := sumologic.NewDataForwardingDestination(ctx, "dataForwardingDestinationResource", &sumologic.DataForwardingDestinationArgs{
	Authentication: &sumologic.DataForwardingDestinationAuthenticationArgs{
		Type:      pulumi.String("string"),
		AccessKey: pulumi.String("string"),
		RoleArn:   pulumi.String("string"),
		SecretKey: pulumi.String("string"),
	},
	BucketName:             pulumi.String("string"),
	DestinationName:        pulumi.String("string"),
	Description:            pulumi.String("string"),
	Enabled:                pulumi.Bool(false),
	S3Region:               pulumi.String("string"),
	S3ServerSideEncryption: pulumi.Bool(false),
})

    var dataForwardingDestinationResource = new DataForwardingDestination("dataForwardingDestinationResource", DataForwardingDestinationArgs.builder()
    .authentication(DataForwardingDestinationAuthenticationArgs.builder()
        .type("string")
        .accessKey("string")
        .roleArn("string")
        .secretKey("string")
        .build())
    .bucketName("string")
    .destinationName("string")
    .description("string")
    .enabled(false)
    .s3Region("string")
    .s3ServerSideEncryption(false)
    .build());

    data_forwarding_destination_resource = sumologic.DataForwardingDestination("dataForwardingDestinationResource",
    authentication={
        "type": "string",
        "access_key": "string",
        "role_arn": "string",
        "secret_key": "string",
    },
    bucket_name="string",
    destination_name="string",
    description="string",
    enabled=False,
    s3_region="string",
    s3_server_side_encryption=False)

    const dataForwardingDestinationResource = new sumologic.DataForwardingDestination("dataForwardingDestinationResource", {
    authentication: {
        type: "string",
        accessKey: "string",
        roleArn: "string",
        secretKey: "string",
    },
    bucketName: "string",
    destinationName: "string",
    description: "string",
    enabled: false,
    s3Region: "string",
    s3ServerSideEncryption: false,
});

    type: sumologic:DataForwardingDestination
properties:
    authentication:
        accessKey: string
        roleArn: string
        secretKey: string
        type: string
    bucketName: string
    description: string
    destinationName: string
    enabled: false
    s3Region: string
    s3ServerSideEncryption: false

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

    Authentication Pulumi.SumoLogic.Inputs.DataForwardingDestinationAuthentication
    BucketName string
    The name of the Amazon S3 bucket.
    DestinationName string
    Name of the S3 data forwarding destination.
    Description string
    Description of the S3 data forwarding destination.
    Enabled bool

    True when the data forwarding destination is enabled. Will be treated as false if left blank.

    The following attributes are exported:

    S3Region string
    The region where the S3 bucket is located.
    S3ServerSideEncryption bool
    Enable S3 server-side encryption.
    Authentication DataForwardingDestinationAuthenticationArgs
    BucketName string
    The name of the Amazon S3 bucket.
    DestinationName string
    Name of the S3 data forwarding destination.
    Description string
    Description of the S3 data forwarding destination.
    Enabled bool

    True when the data forwarding destination is enabled. Will be treated as false if left blank.

    The following attributes are exported:

    S3Region string
    The region where the S3 bucket is located.
    S3ServerSideEncryption bool
    Enable S3 server-side encryption.
    authentication DataForwardingDestinationAuthentication
    bucketName String
    The name of the Amazon S3 bucket.
    destinationName String
    Name of the S3 data forwarding destination.
    description String
    Description of the S3 data forwarding destination.
    enabled Boolean

    True when the data forwarding destination is enabled. Will be treated as false if left blank.

    The following attributes are exported:

    s3Region String
    The region where the S3 bucket is located.
    s3ServerSideEncryption Boolean
    Enable S3 server-side encryption.
    authentication DataForwardingDestinationAuthentication
    bucketName string
    The name of the Amazon S3 bucket.
    destinationName string
    Name of the S3 data forwarding destination.
    description string
    Description of the S3 data forwarding destination.
    enabled boolean

    True when the data forwarding destination is enabled. Will be treated as false if left blank.

    The following attributes are exported:

    s3Region string
    The region where the S3 bucket is located.
    s3ServerSideEncryption boolean
    Enable S3 server-side encryption.
    authentication DataForwardingDestinationAuthenticationArgs
    bucket_name str
    The name of the Amazon S3 bucket.
    destination_name str
    Name of the S3 data forwarding destination.
    description str
    Description of the S3 data forwarding destination.
    enabled bool

    True when the data forwarding destination is enabled. Will be treated as false if left blank.

    The following attributes are exported:

    s3_region str
    The region where the S3 bucket is located.
    s3_server_side_encryption bool
    Enable S3 server-side encryption.
    authentication Property Map
    bucketName String
    The name of the Amazon S3 bucket.
    destinationName String
    Name of the S3 data forwarding destination.
    description String
    Description of the S3 data forwarding destination.
    enabled Boolean

    True when the data forwarding destination is enabled. Will be treated as false if left blank.

    The following attributes are exported:

    s3Region String
    The region where the S3 bucket is located.
    s3ServerSideEncryption Boolean
    Enable S3 server-side encryption.

    Outputs

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

    Get an existing DataForwardingDestination 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?: DataForwardingDestinationState, opts?: CustomResourceOptions): DataForwardingDestination
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        authentication: Optional[DataForwardingDestinationAuthenticationArgs] = None,
        bucket_name: Optional[str] = None,
        description: Optional[str] = None,
        destination_name: Optional[str] = None,
        enabled: Optional[bool] = None,
        s3_region: Optional[str] = None,
        s3_server_side_encryption: Optional[bool] = None) -> DataForwardingDestination
    func GetDataForwardingDestination(ctx *Context, name string, id IDInput, state *DataForwardingDestinationState, opts ...ResourceOption) (*DataForwardingDestination, error)
    public static DataForwardingDestination Get(string name, Input<string> id, DataForwardingDestinationState? state, CustomResourceOptions? opts = null)
    public static DataForwardingDestination get(String name, Output<String> id, DataForwardingDestinationState 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:
    Authentication Pulumi.SumoLogic.Inputs.DataForwardingDestinationAuthentication
    BucketName string
    The name of the Amazon S3 bucket.
    Description string
    Description of the S3 data forwarding destination.
    DestinationName string
    Name of the S3 data forwarding destination.
    Enabled bool

    True when the data forwarding destination is enabled. Will be treated as false if left blank.

    The following attributes are exported:

    S3Region string
    The region where the S3 bucket is located.
    S3ServerSideEncryption bool
    Enable S3 server-side encryption.
    Authentication DataForwardingDestinationAuthenticationArgs
    BucketName string
    The name of the Amazon S3 bucket.
    Description string
    Description of the S3 data forwarding destination.
    DestinationName string
    Name of the S3 data forwarding destination.
    Enabled bool

    True when the data forwarding destination is enabled. Will be treated as false if left blank.

    The following attributes are exported:

    S3Region string
    The region where the S3 bucket is located.
    S3ServerSideEncryption bool
    Enable S3 server-side encryption.
    authentication DataForwardingDestinationAuthentication
    bucketName String
    The name of the Amazon S3 bucket.
    description String
    Description of the S3 data forwarding destination.
    destinationName String
    Name of the S3 data forwarding destination.
    enabled Boolean

    True when the data forwarding destination is enabled. Will be treated as false if left blank.

    The following attributes are exported:

    s3Region String
    The region where the S3 bucket is located.
    s3ServerSideEncryption Boolean
    Enable S3 server-side encryption.
    authentication DataForwardingDestinationAuthentication
    bucketName string
    The name of the Amazon S3 bucket.
    description string
    Description of the S3 data forwarding destination.
    destinationName string
    Name of the S3 data forwarding destination.
    enabled boolean

    True when the data forwarding destination is enabled. Will be treated as false if left blank.

    The following attributes are exported:

    s3Region string
    The region where the S3 bucket is located.
    s3ServerSideEncryption boolean
    Enable S3 server-side encryption.
    authentication DataForwardingDestinationAuthenticationArgs
    bucket_name str
    The name of the Amazon S3 bucket.
    description str
    Description of the S3 data forwarding destination.
    destination_name str
    Name of the S3 data forwarding destination.
    enabled bool

    True when the data forwarding destination is enabled. Will be treated as false if left blank.

    The following attributes are exported:

    s3_region str
    The region where the S3 bucket is located.
    s3_server_side_encryption bool
    Enable S3 server-side encryption.
    authentication Property Map
    bucketName String
    The name of the Amazon S3 bucket.
    description String
    Description of the S3 data forwarding destination.
    destinationName String
    Name of the S3 data forwarding destination.
    enabled Boolean

    True when the data forwarding destination is enabled. Will be treated as false if left blank.

    The following attributes are exported:

    s3Region String
    The region where the S3 bucket is located.
    s3ServerSideEncryption Boolean
    Enable S3 server-side encryption.

    Supporting Types

    DataForwardingDestinationAuthentication, DataForwardingDestinationAuthenticationArgs

    Type string
    AWS IAM authentication method used for access. Possible values are: 1. AccessKey 2. RoleBased
    AccessKey string
    The AWS Access ID to access the S3 bucket.
    RoleArn string
    The AWS Role ARN to access the S3 bucket.
    SecretKey string
    The AWS Secret Key to access the S3 bucket.
    Type string
    AWS IAM authentication method used for access. Possible values are: 1. AccessKey 2. RoleBased
    AccessKey string
    The AWS Access ID to access the S3 bucket.
    RoleArn string
    The AWS Role ARN to access the S3 bucket.
    SecretKey string
    The AWS Secret Key to access the S3 bucket.
    type String
    AWS IAM authentication method used for access. Possible values are: 1. AccessKey 2. RoleBased
    accessKey String
    The AWS Access ID to access the S3 bucket.
    roleArn String
    The AWS Role ARN to access the S3 bucket.
    secretKey String
    The AWS Secret Key to access the S3 bucket.
    type string
    AWS IAM authentication method used for access. Possible values are: 1. AccessKey 2. RoleBased
    accessKey string
    The AWS Access ID to access the S3 bucket.
    roleArn string
    The AWS Role ARN to access the S3 bucket.
    secretKey string
    The AWS Secret Key to access the S3 bucket.
    type str
    AWS IAM authentication method used for access. Possible values are: 1. AccessKey 2. RoleBased
    access_key str
    The AWS Access ID to access the S3 bucket.
    role_arn str
    The AWS Role ARN to access the S3 bucket.
    secret_key str
    The AWS Secret Key to access the S3 bucket.
    type String
    AWS IAM authentication method used for access. Possible values are: 1. AccessKey 2. RoleBased
    accessKey String
    The AWS Access ID to access the S3 bucket.
    roleArn String
    The AWS Role ARN to access the S3 bucket.
    secretKey String
    The AWS Secret Key to access the S3 bucket.

    Package Details

    Repository
    Sumo Logic pulumi/pulumi-sumologic
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the sumologic Terraform Provider.
    sumologic logo
    Sumo Logic v0.23.7 published on Thursday, Oct 24, 2024 by Pulumi
    pulumi/pulumi-sumologic