Please wait. This can take some minutes ...
Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.pulumi.aws.cloudtrail.kotlin.EventDataStore.kt Maven / Gradle / Ivy
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.aws.cloudtrail.kotlin
import com.pulumi.aws.cloudtrail.kotlin.outputs.EventDataStoreAdvancedEventSelector
import com.pulumi.aws.cloudtrail.kotlin.outputs.EventDataStoreAdvancedEventSelector.Companion.toKotlin
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.Deprecated
import kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.collections.Map
/**
* Builder for [EventDataStore].
*/
@PulumiTagMarker
public class EventDataStoreResourceBuilder internal constructor() {
public var name: String? = null
public var args: EventDataStoreArgs = EventDataStoreArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend EventDataStoreArgsBuilder.() -> Unit) {
val builder = EventDataStoreArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): EventDataStore {
val builtJavaResource = com.pulumi.aws.cloudtrail.EventDataStore(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return EventDataStore(builtJavaResource)
}
}
/**
* Provides a CloudTrail Event Data Store.
* More information about event data stores can be found in the [Event Data Store User Guide](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-event-data-store.html).
* > **Tip:** For an organization event data store you must create this resource in the management account.
* ## Example Usage
* ### Basic
* The most simple event data store configuration requires us to only set the `name` attribute. The event data store will automatically capture all management events. To capture management events from all the regions, `multi_region_enabled` must be `true`.
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
* const example = new aws.cloudtrail.EventDataStore("example", {name: "example-event-data-store"});
* ```
* ```python
* import pulumi
* import pulumi_aws as aws
* example = aws.cloudtrail.EventDataStore("example", name="example-event-data-store")
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Aws = Pulumi.Aws;
* return await Deployment.RunAsync(() =>
* {
* var example = new Aws.CloudTrail.EventDataStore("example", new()
* {
* Name = "example-event-data-store",
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-aws/sdk/v6/go/aws/cloudtrail"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _, err := cloudtrail.NewEventDataStore(ctx, "example", &cloudtrail.EventDataStoreArgs{
* Name: pulumi.String("example-event-data-store"),
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* package generated_program;
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.aws.cloudtrail.EventDataStore;
* import com.pulumi.aws.cloudtrail.EventDataStoreArgs;
* 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 EventDataStore("example", EventDataStoreArgs.builder()
* .name("example-event-data-store")
* .build());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: aws:cloudtrail:EventDataStore
* properties:
* name: example-event-data-store
* ```
*
* ### Data Event Logging
* CloudTrail can log [Data Events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html) for certain services such as S3 bucket objects and Lambda function invocations. Additional information about data event configuration can be found in the following links:
* - [CloudTrail API AdvancedFieldSelector documentation](https://docs.aws.amazon.com/awscloudtrail/latest/APIReference/API_AdvancedFieldSelector.html)
* ### Log all DynamoDB PutEvent actions for a specific DynamoDB table
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
* const table = aws.dynamodb.getTable({
* name: "not-important-dynamodb-table",
* });
* const example = new aws.cloudtrail.EventDataStore("example", {advancedEventSelectors: [{
* name: "Log all DynamoDB PutEvent actions for a specific DynamoDB table",
* fieldSelectors: [
* {
* field: "eventCategory",
* equals: ["Data"],
* },
* {
* field: "resources.type",
* equals: ["AWS::DynamoDB::Table"],
* },
* {
* field: "eventName",
* equals: ["PutItem"],
* },
* {
* field: "resources.ARN",
* equals: [table.then(table => table.arn)],
* },
* ],
* }]});
* ```
* ```python
* import pulumi
* import pulumi_aws as aws
* table = aws.dynamodb.get_table(name="not-important-dynamodb-table")
* example = aws.cloudtrail.EventDataStore("example", advanced_event_selectors=[{
* "name": "Log all DynamoDB PutEvent actions for a specific DynamoDB table",
* "field_selectors": [
* {
* "field": "eventCategory",
* "equals": ["Data"],
* },
* {
* "field": "resources.type",
* "equals": ["AWS::DynamoDB::Table"],
* },
* {
* "field": "eventName",
* "equals": ["PutItem"],
* },
* {
* "field": "resources.ARN",
* "equals": [table.arn],
* },
* ],
* }])
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Aws = Pulumi.Aws;
* return await Deployment.RunAsync(() =>
* {
* var table = Aws.DynamoDB.GetTable.Invoke(new()
* {
* Name = "not-important-dynamodb-table",
* });
* var example = new Aws.CloudTrail.EventDataStore("example", new()
* {
* AdvancedEventSelectors = new[]
* {
* new Aws.CloudTrail.Inputs.EventDataStoreAdvancedEventSelectorArgs
* {
* Name = "Log all DynamoDB PutEvent actions for a specific DynamoDB table",
* FieldSelectors = new[]
* {
* new Aws.CloudTrail.Inputs.EventDataStoreAdvancedEventSelectorFieldSelectorArgs
* {
* Field = "eventCategory",
* Equals = new[]
* {
* "Data",
* },
* },
* new Aws.CloudTrail.Inputs.EventDataStoreAdvancedEventSelectorFieldSelectorArgs
* {
* Field = "resources.type",
* Equals = new[]
* {
* "AWS::DynamoDB::Table",
* },
* },
* new Aws.CloudTrail.Inputs.EventDataStoreAdvancedEventSelectorFieldSelectorArgs
* {
* Field = "eventName",
* Equals = new[]
* {
* "PutItem",
* },
* },
* new Aws.CloudTrail.Inputs.EventDataStoreAdvancedEventSelectorFieldSelectorArgs
* {
* Field = "resources.ARN",
* Equals = new[]
* {
* table.Apply(getTableResult => getTableResult.Arn),
* },
* },
* },
* },
* },
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-aws/sdk/v6/go/aws/cloudtrail"
* "github.com/pulumi/pulumi-aws/sdk/v6/go/aws/dynamodb"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* table, err := dynamodb.LookupTable(ctx, &dynamodb.LookupTableArgs{
* Name: "not-important-dynamodb-table",
* }, nil)
* if err != nil {
* return err
* }
* _, err = cloudtrail.NewEventDataStore(ctx, "example", &cloudtrail.EventDataStoreArgs{
* AdvancedEventSelectors: cloudtrail.EventDataStoreAdvancedEventSelectorArray{
* &cloudtrail.EventDataStoreAdvancedEventSelectorArgs{
* Name: pulumi.String("Log all DynamoDB PutEvent actions for a specific DynamoDB table"),
* FieldSelectors: cloudtrail.EventDataStoreAdvancedEventSelectorFieldSelectorArray{
* &cloudtrail.EventDataStoreAdvancedEventSelectorFieldSelectorArgs{
* Field: pulumi.String("eventCategory"),
* Equals: pulumi.StringArray{
* pulumi.String("Data"),
* },
* },
* &cloudtrail.EventDataStoreAdvancedEventSelectorFieldSelectorArgs{
* Field: pulumi.String("resources.type"),
* Equals: pulumi.StringArray{
* pulumi.String("AWS::DynamoDB::Table"),
* },
* },
* &cloudtrail.EventDataStoreAdvancedEventSelectorFieldSelectorArgs{
* Field: pulumi.String("eventName"),
* Equals: pulumi.StringArray{
* pulumi.String("PutItem"),
* },
* },
* &cloudtrail.EventDataStoreAdvancedEventSelectorFieldSelectorArgs{
* Field: pulumi.String("resources.ARN"),
* Equals: pulumi.StringArray{
* pulumi.String(table.Arn),
* },
* },
* },
* },
* },
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* package generated_program;
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.aws.dynamodb.DynamodbFunctions;
* import com.pulumi.aws.dynamodb.inputs.GetTableArgs;
* import com.pulumi.aws.cloudtrail.EventDataStore;
* import com.pulumi.aws.cloudtrail.EventDataStoreArgs;
* import com.pulumi.aws.cloudtrail.inputs.EventDataStoreAdvancedEventSelectorArgs;
* 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) {
* final var table = DynamodbFunctions.getTable(GetTableArgs.builder()
* .name("not-important-dynamodb-table")
* .build());
* var example = new EventDataStore("example", EventDataStoreArgs.builder()
* .advancedEventSelectors(EventDataStoreAdvancedEventSelectorArgs.builder()
* .name("Log all DynamoDB PutEvent actions for a specific DynamoDB table")
* .fieldSelectors(
* EventDataStoreAdvancedEventSelectorFieldSelectorArgs.builder()
* .field("eventCategory")
* .equals("Data")
* .build(),
* EventDataStoreAdvancedEventSelectorFieldSelectorArgs.builder()
* .field("resources.type")
* .equals("AWS::DynamoDB::Table")
* .build(),
* EventDataStoreAdvancedEventSelectorFieldSelectorArgs.builder()
* .field("eventName")
* .equals("PutItem")
* .build(),
* EventDataStoreAdvancedEventSelectorFieldSelectorArgs.builder()
* .field("resources.ARN")
* .equals(table.applyValue(getTableResult -> getTableResult.arn()))
* .build())
* .build())
* .build());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: aws:cloudtrail:EventDataStore
* properties:
* advancedEventSelectors:
* - name: Log all DynamoDB PutEvent actions for a specific DynamoDB table
* fieldSelectors:
* - field: eventCategory
* equals:
* - Data
* - field: resources.type
* equals:
* - AWS::DynamoDB::Table
* - field: eventName
* equals:
* - PutItem
* - field: resources.ARN
* equals:
* - ${table.arn}
* variables:
* table:
* fn::invoke:
* Function: aws:dynamodb:getTable
* Arguments:
* name: not-important-dynamodb-table
* ```
*
* ## Import
* Using `pulumi import`, import event data stores using their `arn`. For example:
* ```sh
* $ pulumi import aws:cloudtrail/eventDataStore:EventDataStore example arn:aws:cloudtrail:us-east-1:123456789123:eventdatastore/22333815-4414-412c-b155-dd254033gfhf
* ```
*/
public class EventDataStore internal constructor(
override val javaResource: com.pulumi.aws.cloudtrail.EventDataStore,
) : KotlinCustomResource(javaResource, EventDataStoreMapper) {
/**
* The advanced event selectors to use to select the events for the data store. For more information about how to use advanced event selectors, see [Log events by using advanced event selectors](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html#creating-data-event-selectors-advanced) in the CloudTrail User Guide.
*/
public val advancedEventSelectors: Output>
get() = javaResource.advancedEventSelectors().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> toKotlin(args0) })
})
})
/**
* ARN of the event data store.
*/
public val arn: Output
get() = javaResource.arn().applyValue({ args0 -> args0 })
/**
* The billing mode for the event data store. The valid values are `EXTENDABLE_RETENTION_PRICING` and `FIXED_RETENTION_PRICING`. Defaults to `EXTENDABLE_RETENTION_PRICING`.
*/
public val billingMode: Output?
get() = javaResource.billingMode().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* Specifies the AWS KMS key ID to use to encrypt the events delivered by CloudTrail. The value can be an alias name prefixed by alias/, a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.
*/
public val kmsKeyId: Output?
get() = javaResource.kmsKeyId().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* Specifies whether the event data store includes events from all regions, or only from the region in which the event data store is created. Default: `true`.
*/
public val multiRegionEnabled: Output?
get() = javaResource.multiRegionEnabled().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The name of the event data store.
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* Specifies whether an event data store collects events logged for an organization in AWS Organizations. Default: `false`.
*/
public val organizationEnabled: Output?
get() = javaResource.organizationEnabled().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The retention period of the event data store, in days. You can set a retention period of up to 2555 days, the equivalent of seven years. Default: `2555`.
*/
public val retentionPeriod: Output?
get() = javaResource.retentionPeriod().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* A map of tags to assign to the resource. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
public val tags: Output>?
get() = javaResource.tags().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
}).orElse(null)
})
/**
* Map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.
*/
@Deprecated(
message = """
Please use `tags` instead.
""",
)
public val tagsAll: Output>
get() = javaResource.tagsAll().applyValue({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
})
/**
* Specifies whether termination protection is enabled for the event data store. If termination protection is enabled, you cannot delete the event data store until termination protection is disabled. Default: `true`.
*/
public val terminationProtectionEnabled: Output?
get() = javaResource.terminationProtectionEnabled().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
}
public object EventDataStoreMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.aws.cloudtrail.EventDataStore::class == javaResource::class
override fun map(javaResource: Resource): EventDataStore = EventDataStore(
javaResource as
com.pulumi.aws.cloudtrail.EventDataStore,
)
}
/**
* @see [EventDataStore].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [EventDataStore].
*/
public suspend fun eventDataStore(
name: String,
block: suspend EventDataStoreResourceBuilder.() -> Unit,
): EventDataStore {
val builder = EventDataStoreResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [EventDataStore].
* @param name The _unique_ name of the resulting resource.
*/
public fun eventDataStore(name: String): EventDataStore {
val builder = EventDataStoreResourceBuilder()
builder.name(name)
return builder.build()
}