@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
237 lines (236 loc) • 9.6 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Resource for managing an AWS Security Lake Subscriber.
*
* > **NOTE:** The underlying `aws.securitylake.DataLake` must be configured before creating the `aws.securitylake.Subscriber`. Use a `dependsOn` statement.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.securitylake.Subscriber("example", {
* subscriberName: "example-name",
* accessType: "S3",
* sources: [{
* awsLogSourceResource: {
* sourceName: "ROUTE53",
* sourceVersion: "1.0",
* },
* }],
* subscriberIdentity: {
* externalId: "example",
* principal: "1234567890",
* },
* }, {
* dependsOn: [exampleAwsSecuritylakeDataLake],
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import Security Lake subscriber using the subscriber ID. For example:
*
* ```sh
* $ pulumi import aws:securitylake/subscriber:Subscriber example 9f3bfe79-d543-474d-a93c-f3846805d208
* ```
*/
export declare class Subscriber extends pulumi.CustomResource {
/**
* Get an existing Subscriber resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SubscriberState, opts?: pulumi.CustomResourceOptions): Subscriber;
/**
* Returns true if the given object is an instance of Subscriber. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Subscriber;
/**
* The Amazon S3 or Lake Formation access type.
*/
readonly accessType: pulumi.Output<string>;
/**
* ARN of the Data Lake.
*/
readonly arn: pulumi.Output<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
readonly region: pulumi.Output<string>;
/**
* The Amazon Resource Name (ARN) which uniquely defines the AWS RAM resource share. Before accepting the RAM resource share invitation, you can view details related to the RAM resource share.
*/
readonly resourceShareArn: pulumi.Output<string>;
/**
* The name of the resource share.
*/
readonly resourceShareName: pulumi.Output<string>;
/**
* The ARN of the IAM role to be used by the entity putting logs into your custom source partition.
*/
readonly roleArn: pulumi.Output<string>;
/**
* The ARN for the Amazon Security Lake Amazon S3 bucket.
*/
readonly s3BucketArn: pulumi.Output<string>;
/**
* The supported AWS services from which logs and events are collected. Security Lake supports log and event collection for natively supported AWS services. See `source` Blocks below.
*/
readonly sources: pulumi.Output<outputs.securitylake.SubscriberSource[] | undefined>;
/**
* The description for your subscriber account in Security Lake.
*/
readonly subscriberDescription: pulumi.Output<string | undefined>;
/**
* The subscriber endpoint to which exception messages are posted.
*/
readonly subscriberEndpoint: pulumi.Output<string>;
/**
* The AWS identity used to access your data. See `subscriberIdentity` Block below.
*/
readonly subscriberIdentity: pulumi.Output<outputs.securitylake.SubscriberSubscriberIdentity | undefined>;
/**
* The name of your Security Lake subscriber account.
*/
readonly subscriberName: pulumi.Output<string | undefined>;
/**
* The subscriber status of the Amazon Security Lake subscriber account.
*/
readonly subscriberStatus: pulumi.Output<string>;
/**
* Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
readonly tagsAll: pulumi.Output<{
[key: string]: string;
}>;
readonly timeouts: pulumi.Output<outputs.securitylake.SubscriberTimeouts | undefined>;
/**
* Create a Subscriber resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args?: SubscriberArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Subscriber resources.
*/
export interface SubscriberState {
/**
* The Amazon S3 or Lake Formation access type.
*/
accessType?: pulumi.Input<string>;
/**
* ARN of the Data Lake.
*/
arn?: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* The Amazon Resource Name (ARN) which uniquely defines the AWS RAM resource share. Before accepting the RAM resource share invitation, you can view details related to the RAM resource share.
*/
resourceShareArn?: pulumi.Input<string>;
/**
* The name of the resource share.
*/
resourceShareName?: pulumi.Input<string>;
/**
* The ARN of the IAM role to be used by the entity putting logs into your custom source partition.
*/
roleArn?: pulumi.Input<string>;
/**
* The ARN for the Amazon Security Lake Amazon S3 bucket.
*/
s3BucketArn?: pulumi.Input<string>;
/**
* The supported AWS services from which logs and events are collected. Security Lake supports log and event collection for natively supported AWS services. See `source` Blocks below.
*/
sources?: pulumi.Input<pulumi.Input<inputs.securitylake.SubscriberSource>[]>;
/**
* The description for your subscriber account in Security Lake.
*/
subscriberDescription?: pulumi.Input<string>;
/**
* The subscriber endpoint to which exception messages are posted.
*/
subscriberEndpoint?: pulumi.Input<string>;
/**
* The AWS identity used to access your data. See `subscriberIdentity` Block below.
*/
subscriberIdentity?: pulumi.Input<inputs.securitylake.SubscriberSubscriberIdentity>;
/**
* The name of your Security Lake subscriber account.
*/
subscriberName?: pulumi.Input<string>;
/**
* The subscriber status of the Amazon Security Lake subscriber account.
*/
subscriberStatus?: pulumi.Input<string>;
/**
* Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
tagsAll?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
timeouts?: pulumi.Input<inputs.securitylake.SubscriberTimeouts>;
}
/**
* The set of arguments for constructing a Subscriber resource.
*/
export interface SubscriberArgs {
/**
* The Amazon S3 or Lake Formation access type.
*/
accessType?: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* The supported AWS services from which logs and events are collected. Security Lake supports log and event collection for natively supported AWS services. See `source` Blocks below.
*/
sources?: pulumi.Input<pulumi.Input<inputs.securitylake.SubscriberSource>[]>;
/**
* The description for your subscriber account in Security Lake.
*/
subscriberDescription?: pulumi.Input<string>;
/**
* The AWS identity used to access your data. See `subscriberIdentity` Block below.
*/
subscriberIdentity?: pulumi.Input<inputs.securitylake.SubscriberSubscriberIdentity>;
/**
* The name of your Security Lake subscriber account.
*/
subscriberName?: pulumi.Input<string>;
/**
* Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
timeouts?: pulumi.Input<inputs.securitylake.SubscriberTimeouts>;
}