Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. sentinel
  5. DataConnectorAwsS3

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

azure.sentinel.DataConnectorAwsS3

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

    Manages a AWS S3 Data Connector.

    Example Usage

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

const example = new azure.core.ResourceGroup("example", {
    name: "example-rg",
    location: "West Europe",
});
const exampleAnalyticsWorkspace = new azure.operationalinsights.AnalyticsWorkspace("example", {
    name: "example-workspace",
    location: example.location,
    resourceGroupName: example.name,
    sku: "PerGB2018",
});
const exampleLogAnalyticsWorkspaceOnboarding = new azure.sentinel.LogAnalyticsWorkspaceOnboarding("example", {workspaceId: exampleAnalyticsWorkspace.id});
const exampleDataConnectorAwsS3 = new azure.sentinel.DataConnectorAwsS3("example", {
    name: "example",
    logAnalyticsWorkspaceId: exampleLogAnalyticsWorkspaceOnboarding.workspaceId,
    awsRoleArn: "arn:aws:iam::000000000000:role/role1",
    destinationTable: "AWSGuardDuty",
    sqsUrls: ["https://sqs.us-east-1.amazonaws.com/000000000000/example"],
});

    import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-rg",
    location="West Europe")
example_analytics_workspace = azure.operationalinsights.AnalyticsWorkspace("example",
    name="example-workspace",
    location=example.location,
    resource_group_name=example.name,
    sku="PerGB2018")
example_log_analytics_workspace_onboarding = azure.sentinel.LogAnalyticsWorkspaceOnboarding("example", workspace_id=example_analytics_workspace.id)
example_data_connector_aws_s3 = azure.sentinel.DataConnectorAwsS3("example",
    name="example",
    log_analytics_workspace_id=example_log_analytics_workspace_onboarding.workspace_id,
    aws_role_arn="arn:aws:iam::000000000000:role/role1",
    destination_table="AWSGuardDuty",
    sqs_urls=["https://sqs.us-east-1.amazonaws.com/000000000000/example"])

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/operationalinsights"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/sentinel"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-rg"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleAnalyticsWorkspace, err := operationalinsights.NewAnalyticsWorkspace(ctx, "example", &operationalinsights.AnalyticsWorkspaceArgs{
			Name:              pulumi.String("example-workspace"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
			Sku:               pulumi.String("PerGB2018"),
		})
		if err != nil {
			return err
		}
		exampleLogAnalyticsWorkspaceOnboarding, err := sentinel.NewLogAnalyticsWorkspaceOnboarding(ctx, "example", &sentinel.LogAnalyticsWorkspaceOnboardingArgs{
			WorkspaceId: exampleAnalyticsWorkspace.ID(),
		})
		if err != nil {
			return err
		}
		_, err = sentinel.NewDataConnectorAwsS3(ctx, "example", &sentinel.DataConnectorAwsS3Args{
			Name:                    pulumi.String("example"),
			LogAnalyticsWorkspaceId: exampleLogAnalyticsWorkspaceOnboarding.WorkspaceId,
			AwsRoleArn:              pulumi.String("arn:aws:iam::000000000000:role/role1"),
			DestinationTable:        pulumi.String("AWSGuardDuty"),
			SqsUrls: pulumi.StringArray{
				pulumi.String("https://sqs.us-east-1.amazonaws.com/000000000000/example"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-rg",
        Location = "West Europe",
    });

    var exampleAnalyticsWorkspace = new Azure.OperationalInsights.AnalyticsWorkspace("example", new()
    {
        Name = "example-workspace",
        Location = example.Location,
        ResourceGroupName = example.Name,
        Sku = "PerGB2018",
    });

    var exampleLogAnalyticsWorkspaceOnboarding = new Azure.Sentinel.LogAnalyticsWorkspaceOnboarding("example", new()
    {
        WorkspaceId = exampleAnalyticsWorkspace.Id,
    });

    var exampleDataConnectorAwsS3 = new Azure.Sentinel.DataConnectorAwsS3("example", new()
    {
        Name = "example",
        LogAnalyticsWorkspaceId = exampleLogAnalyticsWorkspaceOnboarding.WorkspaceId,
        AwsRoleArn = "arn:aws:iam::000000000000:role/role1",
        DestinationTable = "AWSGuardDuty",
        SqsUrls = new[]
        {
            "https://sqs.us-east-1.amazonaws.com/000000000000/example",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.operationalinsights.AnalyticsWorkspace;
import com.pulumi.azure.operationalinsights.AnalyticsWorkspaceArgs;
import com.pulumi.azure.sentinel.LogAnalyticsWorkspaceOnboarding;
import com.pulumi.azure.sentinel.LogAnalyticsWorkspaceOnboardingArgs;
import com.pulumi.azure.sentinel.DataConnectorAwsS3;
import com.pulumi.azure.sentinel.DataConnectorAwsS3Args;
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 ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-rg")
            .location("West Europe")
            .build());

        var exampleAnalyticsWorkspace = new AnalyticsWorkspace("exampleAnalyticsWorkspace", AnalyticsWorkspaceArgs.builder()
            .name("example-workspace")
            .location(example.location())
            .resourceGroupName(example.name())
            .sku("PerGB2018")
            .build());

        var exampleLogAnalyticsWorkspaceOnboarding = new LogAnalyticsWorkspaceOnboarding("exampleLogAnalyticsWorkspaceOnboarding", LogAnalyticsWorkspaceOnboardingArgs.builder()
            .workspaceId(exampleAnalyticsWorkspace.id())
            .build());

        var exampleDataConnectorAwsS3 = new DataConnectorAwsS3("exampleDataConnectorAwsS3", DataConnectorAwsS3Args.builder()
            .name("example")
            .logAnalyticsWorkspaceId(exampleLogAnalyticsWorkspaceOnboarding.workspaceId())
            .awsRoleArn("arn:aws:iam::000000000000:role/role1")
            .destinationTable("AWSGuardDuty")
            .sqsUrls("https://sqs.us-east-1.amazonaws.com/000000000000/example")
            .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-rg
      location: West Europe
  exampleAnalyticsWorkspace:
    type: azure:operationalinsights:AnalyticsWorkspace
    name: example
    properties:
      name: example-workspace
      location: ${example.location}
      resourceGroupName: ${example.name}
      sku: PerGB2018
  exampleLogAnalyticsWorkspaceOnboarding:
    type: azure:sentinel:LogAnalyticsWorkspaceOnboarding
    name: example
    properties:
      workspaceId: ${exampleAnalyticsWorkspace.id}
  exampleDataConnectorAwsS3:
    type: azure:sentinel:DataConnectorAwsS3
    name: example
    properties:
      name: example
      logAnalyticsWorkspaceId: ${exampleLogAnalyticsWorkspaceOnboarding.workspaceId}
      awsRoleArn: arn:aws:iam::000000000000:role/role1
      destinationTable: AWSGuardDuty
      sqsUrls:
        - https://sqs.us-east-1.amazonaws.com/000000000000/example

    Create DataConnectorAwsS3 Resource

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

    Constructor syntax

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

@overload
def DataConnectorAwsS3(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       aws_role_arn: Optional[str] = None,
                       destination_table: Optional[str] = None,
                       log_analytics_workspace_id: Optional[str] = None,
                       sqs_urls: Optional[Sequence[str]] = None,
                       name: Optional[str] = None)
    func NewDataConnectorAwsS3(ctx *Context, name string, args DataConnectorAwsS3Args, opts ...ResourceOption) (*DataConnectorAwsS3, error)
    public DataConnectorAwsS3(string name, DataConnectorAwsS3Args args, CustomResourceOptions? opts = null)
    public DataConnectorAwsS3(String name, DataConnectorAwsS3Args args)
public DataConnectorAwsS3(String name, DataConnectorAwsS3Args args, CustomResourceOptions options)

    type: azure:sentinel:DataConnectorAwsS3
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 DataConnectorAwsS3Args
    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 DataConnectorAwsS3Args
    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 DataConnectorAwsS3Args
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DataConnectorAwsS3Args
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DataConnectorAwsS3Args
    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 dataConnectorAwsS3Resource = new Azure.Sentinel.DataConnectorAwsS3("dataConnectorAwsS3Resource", new()
{
    AwsRoleArn = "string",
    DestinationTable = "string",
    LogAnalyticsWorkspaceId = "string",
    SqsUrls = new[]
    {
        "string",
    },
    Name = "string",
});

    example, err := sentinel.NewDataConnectorAwsS3(ctx, "dataConnectorAwsS3Resource", &sentinel.DataConnectorAwsS3Args{
	AwsRoleArn:              pulumi.String("string"),
	DestinationTable:        pulumi.String("string"),
	LogAnalyticsWorkspaceId: pulumi.String("string"),
	SqsUrls: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name: pulumi.String("string"),
})

    var dataConnectorAwsS3Resource = new DataConnectorAwsS3("dataConnectorAwsS3Resource", DataConnectorAwsS3Args.builder()
    .awsRoleArn("string")
    .destinationTable("string")
    .logAnalyticsWorkspaceId("string")
    .sqsUrls("string")
    .name("string")
    .build());

    data_connector_aws_s3_resource = azure.sentinel.DataConnectorAwsS3("dataConnectorAwsS3Resource",
    aws_role_arn="string",
    destination_table="string",
    log_analytics_workspace_id="string",
    sqs_urls=["string"],
    name="string")

    const dataConnectorAwsS3Resource = new azure.sentinel.DataConnectorAwsS3("dataConnectorAwsS3Resource", {
    awsRoleArn: "string",
    destinationTable: "string",
    logAnalyticsWorkspaceId: "string",
    sqsUrls: ["string"],
    name: "string",
});

    type: azure:sentinel:DataConnectorAwsS3
properties:
    awsRoleArn: string
    destinationTable: string
    logAnalyticsWorkspaceId: string
    name: string
    sqsUrls:
        - string

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

    AwsRoleArn string
    The ARN of the AWS role, which is connected to this AWS CloudTrail Data Connector. See the Azure document for details.
    DestinationTable string
    The name of the Log Analytics table that will store the ingested data.
    LogAnalyticsWorkspaceId string
    The ID of the Log Analytics Workspace that this AWS S3 Data Connector resides in. Changing this forces a new AWS S3 Data Connector to be created.
    SqsUrls List<string>
    Specifies a list of AWS SQS urls for the AWS S3 Data Connector.
    Name string
    The name which should be used for this AWS S3 Data Connector. Changing this forces a new AWS S3 Data Connector to be created.
    AwsRoleArn string
    The ARN of the AWS role, which is connected to this AWS CloudTrail Data Connector. See the Azure document for details.
    DestinationTable string
    The name of the Log Analytics table that will store the ingested data.
    LogAnalyticsWorkspaceId string
    The ID of the Log Analytics Workspace that this AWS S3 Data Connector resides in. Changing this forces a new AWS S3 Data Connector to be created.
    SqsUrls []string
    Specifies a list of AWS SQS urls for the AWS S3 Data Connector.
    Name string
    The name which should be used for this AWS S3 Data Connector. Changing this forces a new AWS S3 Data Connector to be created.
    awsRoleArn String
    The ARN of the AWS role, which is connected to this AWS CloudTrail Data Connector. See the Azure document for details.
    destinationTable String
    The name of the Log Analytics table that will store the ingested data.
    logAnalyticsWorkspaceId String
    The ID of the Log Analytics Workspace that this AWS S3 Data Connector resides in. Changing this forces a new AWS S3 Data Connector to be created.
    sqsUrls List<String>
    Specifies a list of AWS SQS urls for the AWS S3 Data Connector.
    name String
    The name which should be used for this AWS S3 Data Connector. Changing this forces a new AWS S3 Data Connector to be created.
    awsRoleArn string
    The ARN of the AWS role, which is connected to this AWS CloudTrail Data Connector. See the Azure document for details.
    destinationTable string
    The name of the Log Analytics table that will store the ingested data.
    logAnalyticsWorkspaceId string
    The ID of the Log Analytics Workspace that this AWS S3 Data Connector resides in. Changing this forces a new AWS S3 Data Connector to be created.
    sqsUrls string[]
    Specifies a list of AWS SQS urls for the AWS S3 Data Connector.
    name string
    The name which should be used for this AWS S3 Data Connector. Changing this forces a new AWS S3 Data Connector to be created.
    aws_role_arn str
    The ARN of the AWS role, which is connected to this AWS CloudTrail Data Connector. See the Azure document for details.
    destination_table str
    The name of the Log Analytics table that will store the ingested data.
    log_analytics_workspace_id str
    The ID of the Log Analytics Workspace that this AWS S3 Data Connector resides in. Changing this forces a new AWS S3 Data Connector to be created.
    sqs_urls Sequence[str]
    Specifies a list of AWS SQS urls for the AWS S3 Data Connector.
    name str
    The name which should be used for this AWS S3 Data Connector. Changing this forces a new AWS S3 Data Connector to be created.
    awsRoleArn String
    The ARN of the AWS role, which is connected to this AWS CloudTrail Data Connector. See the Azure document for details.
    destinationTable String
    The name of the Log Analytics table that will store the ingested data.
    logAnalyticsWorkspaceId String
    The ID of the Log Analytics Workspace that this AWS S3 Data Connector resides in. Changing this forces a new AWS S3 Data Connector to be created.
    sqsUrls List<String>
    Specifies a list of AWS SQS urls for the AWS S3 Data Connector.
    name String
    The name which should be used for this AWS S3 Data Connector. Changing this forces a new AWS S3 Data Connector to be created.

    Outputs

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

    Get an existing DataConnectorAwsS3 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?: DataConnectorAwsS3State, opts?: CustomResourceOptions): DataConnectorAwsS3
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        aws_role_arn: Optional[str] = None,
        destination_table: Optional[str] = None,
        log_analytics_workspace_id: Optional[str] = None,
        name: Optional[str] = None,
        sqs_urls: Optional[Sequence[str]] = None) -> DataConnectorAwsS3
    func GetDataConnectorAwsS3(ctx *Context, name string, id IDInput, state *DataConnectorAwsS3State, opts ...ResourceOption) (*DataConnectorAwsS3, error)
    public static DataConnectorAwsS3 Get(string name, Input<string> id, DataConnectorAwsS3State? state, CustomResourceOptions? opts = null)
    public static DataConnectorAwsS3 get(String name, Output<String> id, DataConnectorAwsS3State 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:
    AwsRoleArn string
    The ARN of the AWS role, which is connected to this AWS CloudTrail Data Connector. See the Azure document for details.
    DestinationTable string
    The name of the Log Analytics table that will store the ingested data.
    LogAnalyticsWorkspaceId string
    The ID of the Log Analytics Workspace that this AWS S3 Data Connector resides in. Changing this forces a new AWS S3 Data Connector to be created.
    Name string
    The name which should be used for this AWS S3 Data Connector. Changing this forces a new AWS S3 Data Connector to be created.
    SqsUrls List<string>
    Specifies a list of AWS SQS urls for the AWS S3 Data Connector.
    AwsRoleArn string
    The ARN of the AWS role, which is connected to this AWS CloudTrail Data Connector. See the Azure document for details.
    DestinationTable string
    The name of the Log Analytics table that will store the ingested data.
    LogAnalyticsWorkspaceId string
    The ID of the Log Analytics Workspace that this AWS S3 Data Connector resides in. Changing this forces a new AWS S3 Data Connector to be created.
    Name string
    The name which should be used for this AWS S3 Data Connector. Changing this forces a new AWS S3 Data Connector to be created.
    SqsUrls []string
    Specifies a list of AWS SQS urls for the AWS S3 Data Connector.
    awsRoleArn String
    The ARN of the AWS role, which is connected to this AWS CloudTrail Data Connector. See the Azure document for details.
    destinationTable String
    The name of the Log Analytics table that will store the ingested data.
    logAnalyticsWorkspaceId String
    The ID of the Log Analytics Workspace that this AWS S3 Data Connector resides in. Changing this forces a new AWS S3 Data Connector to be created.
    name String
    The name which should be used for this AWS S3 Data Connector. Changing this forces a new AWS S3 Data Connector to be created.
    sqsUrls List<String>
    Specifies a list of AWS SQS urls for the AWS S3 Data Connector.
    awsRoleArn string
    The ARN of the AWS role, which is connected to this AWS CloudTrail Data Connector. See the Azure document for details.
    destinationTable string
    The name of the Log Analytics table that will store the ingested data.
    logAnalyticsWorkspaceId string
    The ID of the Log Analytics Workspace that this AWS S3 Data Connector resides in. Changing this forces a new AWS S3 Data Connector to be created.
    name string
    The name which should be used for this AWS S3 Data Connector. Changing this forces a new AWS S3 Data Connector to be created.
    sqsUrls string[]
    Specifies a list of AWS SQS urls for the AWS S3 Data Connector.
    aws_role_arn str
    The ARN of the AWS role, which is connected to this AWS CloudTrail Data Connector. See the Azure document for details.
    destination_table str
    The name of the Log Analytics table that will store the ingested data.
    log_analytics_workspace_id str
    The ID of the Log Analytics Workspace that this AWS S3 Data Connector resides in. Changing this forces a new AWS S3 Data Connector to be created.
    name str
    The name which should be used for this AWS S3 Data Connector. Changing this forces a new AWS S3 Data Connector to be created.
    sqs_urls Sequence[str]
    Specifies a list of AWS SQS urls for the AWS S3 Data Connector.
    awsRoleArn String
    The ARN of the AWS role, which is connected to this AWS CloudTrail Data Connector. See the Azure document for details.
    destinationTable String
    The name of the Log Analytics table that will store the ingested data.
    logAnalyticsWorkspaceId String
    The ID of the Log Analytics Workspace that this AWS S3 Data Connector resides in. Changing this forces a new AWS S3 Data Connector to be created.
    name String
    The name which should be used for this AWS S3 Data Connector. Changing this forces a new AWS S3 Data Connector to be created.
    sqsUrls List<String>
    Specifies a list of AWS SQS urls for the AWS S3 Data Connector.

    Import

    AWS S3 Data Connectors can be imported using the resource id, e.g.

    $ pulumi import azure:sentinel/dataConnectorAwsS3:DataConnectorAwsS3 example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.OperationalInsights/workspaces/workspace1/providers/Microsoft.SecurityInsights/dataConnectors/dc1

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-azure