Azure Classic

v5.25.0 published on Thursday, Nov 24, 2022 by Pulumi

DataConnectorAwsS3

Manages a AWS S3 Data Connector.

Example Usage

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

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

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

    var exampleAnalyticsSolution = new Azure.OperationalInsights.AnalyticsSolution("exampleAnalyticsSolution", new()
    {
        SolutionName = "SecurityInsights",
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
        WorkspaceResourceId = exampleAnalyticsWorkspace.Id,
        WorkspaceName = exampleAnalyticsWorkspace.Name,
        Plan = new Azure.OperationalInsights.Inputs.AnalyticsSolutionPlanArgs
        {
            Publisher = "Microsoft",
            Product = "OMSGallery/SecurityInsights",
        },
    });

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

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleAnalyticsWorkspace, err := operationalinsights.NewAnalyticsWorkspace(ctx, "exampleAnalyticsWorkspace", &operationalinsights.AnalyticsWorkspaceArgs{
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.Name,
			Sku:               pulumi.String("PerGB2018"),
		})
		if err != nil {
			return err
		}
		exampleAnalyticsSolution, err := operationalinsights.NewAnalyticsSolution(ctx, "exampleAnalyticsSolution", &operationalinsights.AnalyticsSolutionArgs{
			SolutionName:        pulumi.String("SecurityInsights"),
			Location:            exampleResourceGroup.Location,
			ResourceGroupName:   exampleResourceGroup.Name,
			WorkspaceResourceId: exampleAnalyticsWorkspace.ID(),
			WorkspaceName:       exampleAnalyticsWorkspace.Name,
			Plan: &operationalinsights.AnalyticsSolutionPlanArgs{
				Publisher: pulumi.String("Microsoft"),
				Product:   pulumi.String("OMSGallery/SecurityInsights"),
			},
		})
		if err != nil {
			return err
		}
		_, err = sentinel.NewDataConnectorAwsS3(ctx, "exampleDataConnectorAwsS3", &sentinel.DataConnectorAwsS3Args{
			LogAnalyticsWorkspaceId: exampleAnalyticsSolution.WorkspaceResourceId,
			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"),
			},
		}, pulumi.DependsOn([]pulumi.Resource{
			exampleAnalyticsSolution,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}
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.operationalinsights.AnalyticsSolution;
import com.pulumi.azure.operationalinsights.AnalyticsSolutionArgs;
import com.pulumi.azure.operationalinsights.inputs.AnalyticsSolutionPlanArgs;
import com.pulumi.azure.sentinel.DataConnectorAwsS3;
import com.pulumi.azure.sentinel.DataConnectorAwsS3Args;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
            .location("West Europe")
            .build());

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

        var exampleAnalyticsSolution = new AnalyticsSolution("exampleAnalyticsSolution", AnalyticsSolutionArgs.builder()        
            .solutionName("SecurityInsights")
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .workspaceResourceId(exampleAnalyticsWorkspace.id())
            .workspaceName(exampleAnalyticsWorkspace.name())
            .plan(AnalyticsSolutionPlanArgs.builder()
                .publisher("Microsoft")
                .product("OMSGallery/SecurityInsights")
                .build())
            .build());

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

    }
}
import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_analytics_workspace = azure.operationalinsights.AnalyticsWorkspace("exampleAnalyticsWorkspace",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    sku="PerGB2018")
example_analytics_solution = azure.operationalinsights.AnalyticsSolution("exampleAnalyticsSolution",
    solution_name="SecurityInsights",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    workspace_resource_id=example_analytics_workspace.id,
    workspace_name=example_analytics_workspace.name,
    plan=azure.operationalinsights.AnalyticsSolutionPlanArgs(
        publisher="Microsoft",
        product="OMSGallery/SecurityInsights",
    ))
example_data_connector_aws_s3 = azure.sentinel.DataConnectorAwsS3("exampleDataConnectorAwsS3",
    log_analytics_workspace_id=example_analytics_solution.workspace_resource_id,
    aws_role_arn="arn:aws:iam::000000000000:role/role1",
    destination_table="AWSGuardDuty",
    sqs_urls=["https://sqs.us-east-1.amazonaws.com/000000000000/example"],
    opts=pulumi.ResourceOptions(depends_on=[example_analytics_solution]))
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleAnalyticsWorkspace = new azure.operationalinsights.AnalyticsWorkspace("exampleAnalyticsWorkspace", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    sku: "PerGB2018",
});
const exampleAnalyticsSolution = new azure.operationalinsights.AnalyticsSolution("exampleAnalyticsSolution", {
    solutionName: "SecurityInsights",
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    workspaceResourceId: exampleAnalyticsWorkspace.id,
    workspaceName: exampleAnalyticsWorkspace.name,
    plan: {
        publisher: "Microsoft",
        product: "OMSGallery/SecurityInsights",
    },
});
const exampleDataConnectorAwsS3 = new azure.sentinel.DataConnectorAwsS3("exampleDataConnectorAwsS3", {
    logAnalyticsWorkspaceId: exampleAnalyticsSolution.workspaceResourceId,
    awsRoleArn: "arn:aws:iam::000000000000:role/role1",
    destinationTable: "AWSGuardDuty",
    sqsUrls: ["https://sqs.us-east-1.amazonaws.com/000000000000/example"],
}, {
    dependsOn: [exampleAnalyticsSolution],
});
resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  exampleAnalyticsWorkspace:
    type: azure:operationalinsights:AnalyticsWorkspace
    properties:
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
      sku: PerGB2018
  exampleAnalyticsSolution:
    type: azure:operationalinsights:AnalyticsSolution
    properties:
      solutionName: SecurityInsights
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
      workspaceResourceId: ${exampleAnalyticsWorkspace.id}
      workspaceName: ${exampleAnalyticsWorkspace.name}
      plan:
        publisher: Microsoft
        product: OMSGallery/SecurityInsights
  exampleDataConnectorAwsS3:
    type: azure:sentinel:DataConnectorAwsS3
    properties:
      logAnalyticsWorkspaceId: ${exampleAnalyticsSolution.workspaceResourceId}
      awsRoleArn: arn:aws:iam::000000000000:role/role1
      destinationTable: AWSGuardDuty
      sqsUrls:
        - https://sqs.us-east-1.amazonaws.com/000000000000/example
    options:
      dependson:
        - ${exampleAnalyticsSolution}

Create DataConnectorAwsS3 Resource

new DataConnectorAwsS3(name: string, args: DataConnectorAwsS3Args, opts?: CustomResourceOptions);
@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,
                       name: Optional[str] = None,
                       sqs_urls: Optional[Sequence[str]] = None)
@overload
def DataConnectorAwsS3(resource_name: str,
                       args: DataConnectorAwsS3Args,
                       opts: Optional[ResourceOptions] = 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.

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.

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

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

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.