aws.securitylake.SubscriberNotification
Explore with Pulumi AI
Resource for managing an AWS Security Lake Subscriber Notification.
Example Usage
SQS Notification
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.securitylake.SubscriberNotification("example", {
subscriberId: exampleAwsSecuritylakeSubscriber.id,
configuration: {
sqsNotificationConfiguration: {},
},
});
import pulumi
import pulumi_aws as aws
example = aws.securitylake.SubscriberNotification("example",
subscriber_id=example_aws_securitylake_subscriber["id"],
configuration={
"sqs_notification_configuration": {},
})
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/securitylake"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := securitylake.NewSubscriberNotification(ctx, "example", &securitylake.SubscriberNotificationArgs{
SubscriberId: pulumi.Any(exampleAwsSecuritylakeSubscriber.Id),
Configuration: &securitylake.SubscriberNotificationConfigurationArgs{
SqsNotificationConfiguration: &securitylake.SubscriberNotificationConfigurationSqsNotificationConfigurationArgs{},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.SecurityLake.SubscriberNotification("example", new()
{
SubscriberId = exampleAwsSecuritylakeSubscriber.Id,
Configuration = new Aws.SecurityLake.Inputs.SubscriberNotificationConfigurationArgs
{
SqsNotificationConfiguration = null,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.securitylake.SubscriberNotification;
import com.pulumi.aws.securitylake.SubscriberNotificationArgs;
import com.pulumi.aws.securitylake.inputs.SubscriberNotificationConfigurationArgs;
import com.pulumi.aws.securitylake.inputs.SubscriberNotificationConfigurationSqsNotificationConfigurationArgs;
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 SubscriberNotification("example", SubscriberNotificationArgs.builder()
.subscriberId(exampleAwsSecuritylakeSubscriber.id())
.configuration(SubscriberNotificationConfigurationArgs.builder()
.sqsNotificationConfiguration()
.build())
.build());
}
}
resources:
example:
type: aws:securitylake:SubscriberNotification
properties:
subscriberId: ${exampleAwsSecuritylakeSubscriber.id}
configuration:
sqsNotificationConfiguration: {}
HTTPS Notification
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.securitylake.SubscriberNotification("example", {
subscriberId: exampleAwsSecuritylakeSubscriber.id,
configuration: {
httpsNotificationConfiguration: {
endpoint: test.apiEndpoint,
targetRoleArn: eventBridge.arn,
},
},
});
import pulumi
import pulumi_aws as aws
example = aws.securitylake.SubscriberNotification("example",
subscriber_id=example_aws_securitylake_subscriber["id"],
configuration={
"https_notification_configuration": {
"endpoint": test["apiEndpoint"],
"target_role_arn": event_bridge["arn"],
},
})
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/securitylake"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := securitylake.NewSubscriberNotification(ctx, "example", &securitylake.SubscriberNotificationArgs{
SubscriberId: pulumi.Any(exampleAwsSecuritylakeSubscriber.Id),
Configuration: &securitylake.SubscriberNotificationConfigurationArgs{
HttpsNotificationConfiguration: &securitylake.SubscriberNotificationConfigurationHttpsNotificationConfigurationArgs{
Endpoint: pulumi.Any(test.ApiEndpoint),
TargetRoleArn: pulumi.Any(eventBridge.Arn),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.SecurityLake.SubscriberNotification("example", new()
{
SubscriberId = exampleAwsSecuritylakeSubscriber.Id,
Configuration = new Aws.SecurityLake.Inputs.SubscriberNotificationConfigurationArgs
{
HttpsNotificationConfiguration = new Aws.SecurityLake.Inputs.SubscriberNotificationConfigurationHttpsNotificationConfigurationArgs
{
Endpoint = test.ApiEndpoint,
TargetRoleArn = eventBridge.Arn,
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.securitylake.SubscriberNotification;
import com.pulumi.aws.securitylake.SubscriberNotificationArgs;
import com.pulumi.aws.securitylake.inputs.SubscriberNotificationConfigurationArgs;
import com.pulumi.aws.securitylake.inputs.SubscriberNotificationConfigurationHttpsNotificationConfigurationArgs;
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 SubscriberNotification("example", SubscriberNotificationArgs.builder()
.subscriberId(exampleAwsSecuritylakeSubscriber.id())
.configuration(SubscriberNotificationConfigurationArgs.builder()
.httpsNotificationConfiguration(SubscriberNotificationConfigurationHttpsNotificationConfigurationArgs.builder()
.endpoint(test.apiEndpoint())
.targetRoleArn(eventBridge.arn())
.build())
.build())
.build());
}
}
resources:
example:
type: aws:securitylake:SubscriberNotification
properties:
subscriberId: ${exampleAwsSecuritylakeSubscriber.id}
configuration:
httpsNotificationConfiguration:
endpoint: ${test.apiEndpoint}
targetRoleArn: ${eventBridge.arn}
Create SubscriberNotification Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new SubscriberNotification(name: string, args: SubscriberNotificationArgs, opts?: CustomResourceOptions);
@overload
def SubscriberNotification(resource_name: str,
args: SubscriberNotificationArgs,
opts: Optional[ResourceOptions] = None)
@overload
def SubscriberNotification(resource_name: str,
opts: Optional[ResourceOptions] = None,
subscriber_id: Optional[str] = None,
configuration: Optional[SubscriberNotificationConfigurationArgs] = None)
func NewSubscriberNotification(ctx *Context, name string, args SubscriberNotificationArgs, opts ...ResourceOption) (*SubscriberNotification, error)
public SubscriberNotification(string name, SubscriberNotificationArgs args, CustomResourceOptions? opts = null)
public SubscriberNotification(String name, SubscriberNotificationArgs args)
public SubscriberNotification(String name, SubscriberNotificationArgs args, CustomResourceOptions options)
type: aws:securitylake:SubscriberNotification
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 SubscriberNotificationArgs
- 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 SubscriberNotificationArgs
- 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 SubscriberNotificationArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SubscriberNotificationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args SubscriberNotificationArgs
- 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 subscriberNotificationResource = new Aws.SecurityLake.SubscriberNotification("subscriberNotificationResource", new()
{
SubscriberId = "string",
Configuration = new Aws.SecurityLake.Inputs.SubscriberNotificationConfigurationArgs
{
HttpsNotificationConfiguration = new Aws.SecurityLake.Inputs.SubscriberNotificationConfigurationHttpsNotificationConfigurationArgs
{
Endpoint = "string",
TargetRoleArn = "string",
AuthorizationApiKeyName = "string",
AuthorizationApiKeyValue = "string",
HttpMethod = "string",
},
SqsNotificationConfiguration = null,
},
});
example, err := securitylake.NewSubscriberNotification(ctx, "subscriberNotificationResource", &securitylake.SubscriberNotificationArgs{
SubscriberId: pulumi.String("string"),
Configuration: &securitylake.SubscriberNotificationConfigurationArgs{
HttpsNotificationConfiguration: &securitylake.SubscriberNotificationConfigurationHttpsNotificationConfigurationArgs{
Endpoint: pulumi.String("string"),
TargetRoleArn: pulumi.String("string"),
AuthorizationApiKeyName: pulumi.String("string"),
AuthorizationApiKeyValue: pulumi.String("string"),
HttpMethod: pulumi.String("string"),
},
SqsNotificationConfiguration: &securitylake.SubscriberNotificationConfigurationSqsNotificationConfigurationArgs{},
},
})
var subscriberNotificationResource = new SubscriberNotification("subscriberNotificationResource", SubscriberNotificationArgs.builder()
.subscriberId("string")
.configuration(SubscriberNotificationConfigurationArgs.builder()
.httpsNotificationConfiguration(SubscriberNotificationConfigurationHttpsNotificationConfigurationArgs.builder()
.endpoint("string")
.targetRoleArn("string")
.authorizationApiKeyName("string")
.authorizationApiKeyValue("string")
.httpMethod("string")
.build())
.sqsNotificationConfiguration()
.build())
.build());
subscriber_notification_resource = aws.securitylake.SubscriberNotification("subscriberNotificationResource",
subscriber_id="string",
configuration={
"https_notification_configuration": {
"endpoint": "string",
"target_role_arn": "string",
"authorization_api_key_name": "string",
"authorization_api_key_value": "string",
"http_method": "string",
},
"sqs_notification_configuration": {},
})
const subscriberNotificationResource = new aws.securitylake.SubscriberNotification("subscriberNotificationResource", {
subscriberId: "string",
configuration: {
httpsNotificationConfiguration: {
endpoint: "string",
targetRoleArn: "string",
authorizationApiKeyName: "string",
authorizationApiKeyValue: "string",
httpMethod: "string",
},
sqsNotificationConfiguration: {},
},
});
type: aws:securitylake:SubscriberNotification
properties:
configuration:
httpsNotificationConfiguration:
authorizationApiKeyName: string
authorizationApiKeyValue: string
endpoint: string
httpMethod: string
targetRoleArn: string
sqsNotificationConfiguration: {}
subscriberId: string
SubscriberNotification 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 SubscriberNotification resource accepts the following input properties:
- Subscriber
Id string - The subscriber ID for the notification subscription.
- Configuration
Subscriber
Notification Configuration - Specify the configuration using which you want to create the subscriber notification..
- Subscriber
Id string - The subscriber ID for the notification subscription.
- Configuration
Subscriber
Notification Configuration Args - Specify the configuration using which you want to create the subscriber notification..
- subscriber
Id String - The subscriber ID for the notification subscription.
- configuration
Subscriber
Notification Configuration - Specify the configuration using which you want to create the subscriber notification..
- subscriber
Id string - The subscriber ID for the notification subscription.
- configuration
Subscriber
Notification Configuration - Specify the configuration using which you want to create the subscriber notification..
- subscriber_
id str - The subscriber ID for the notification subscription.
- configuration
Subscriber
Notification Configuration Args - Specify the configuration using which you want to create the subscriber notification..
- subscriber
Id String - The subscriber ID for the notification subscription.
- configuration Property Map
- Specify the configuration using which you want to create the subscriber notification..
Outputs
All input properties are implicitly available as output properties. Additionally, the SubscriberNotification resource produces the following output properties:
- Endpoint
Id string - (Deprecated) The subscriber endpoint to which exception messages are posted.
- Id string
- The provider-assigned unique ID for this managed resource.
- Subscriber
Endpoint string - The subscriber endpoint to which exception messages are posted.
- Endpoint
Id string - (Deprecated) The subscriber endpoint to which exception messages are posted.
- Id string
- The provider-assigned unique ID for this managed resource.
- Subscriber
Endpoint string - The subscriber endpoint to which exception messages are posted.
- endpoint
Id String - (Deprecated) The subscriber endpoint to which exception messages are posted.
- id String
- The provider-assigned unique ID for this managed resource.
- subscriber
Endpoint String - The subscriber endpoint to which exception messages are posted.
- endpoint
Id string - (Deprecated) The subscriber endpoint to which exception messages are posted.
- id string
- The provider-assigned unique ID for this managed resource.
- subscriber
Endpoint string - The subscriber endpoint to which exception messages are posted.
- endpoint_
id str - (Deprecated) The subscriber endpoint to which exception messages are posted.
- id str
- The provider-assigned unique ID for this managed resource.
- subscriber_
endpoint str - The subscriber endpoint to which exception messages are posted.
- endpoint
Id String - (Deprecated) The subscriber endpoint to which exception messages are posted.
- id String
- The provider-assigned unique ID for this managed resource.
- subscriber
Endpoint String - The subscriber endpoint to which exception messages are posted.
Look up Existing SubscriberNotification Resource
Get an existing SubscriberNotification 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?: SubscriberNotificationState, opts?: CustomResourceOptions): SubscriberNotification
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
configuration: Optional[SubscriberNotificationConfigurationArgs] = None,
endpoint_id: Optional[str] = None,
subscriber_endpoint: Optional[str] = None,
subscriber_id: Optional[str] = None) -> SubscriberNotification
func GetSubscriberNotification(ctx *Context, name string, id IDInput, state *SubscriberNotificationState, opts ...ResourceOption) (*SubscriberNotification, error)
public static SubscriberNotification Get(string name, Input<string> id, SubscriberNotificationState? state, CustomResourceOptions? opts = null)
public static SubscriberNotification get(String name, Output<String> id, SubscriberNotificationState 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.
- Configuration
Subscriber
Notification Configuration - Specify the configuration using which you want to create the subscriber notification..
- Endpoint
Id string - (Deprecated) The subscriber endpoint to which exception messages are posted.
- Subscriber
Endpoint string - The subscriber endpoint to which exception messages are posted.
- Subscriber
Id string - The subscriber ID for the notification subscription.
- Configuration
Subscriber
Notification Configuration Args - Specify the configuration using which you want to create the subscriber notification..
- Endpoint
Id string - (Deprecated) The subscriber endpoint to which exception messages are posted.
- Subscriber
Endpoint string - The subscriber endpoint to which exception messages are posted.
- Subscriber
Id string - The subscriber ID for the notification subscription.
- configuration
Subscriber
Notification Configuration - Specify the configuration using which you want to create the subscriber notification..
- endpoint
Id String - (Deprecated) The subscriber endpoint to which exception messages are posted.
- subscriber
Endpoint String - The subscriber endpoint to which exception messages are posted.
- subscriber
Id String - The subscriber ID for the notification subscription.
- configuration
Subscriber
Notification Configuration - Specify the configuration using which you want to create the subscriber notification..
- endpoint
Id string - (Deprecated) The subscriber endpoint to which exception messages are posted.
- subscriber
Endpoint string - The subscriber endpoint to which exception messages are posted.
- subscriber
Id string - The subscriber ID for the notification subscription.
- configuration
Subscriber
Notification Configuration Args - Specify the configuration using which you want to create the subscriber notification..
- endpoint_
id str - (Deprecated) The subscriber endpoint to which exception messages are posted.
- subscriber_
endpoint str - The subscriber endpoint to which exception messages are posted.
- subscriber_
id str - The subscriber ID for the notification subscription.
- configuration Property Map
- Specify the configuration using which you want to create the subscriber notification..
- endpoint
Id String - (Deprecated) The subscriber endpoint to which exception messages are posted.
- subscriber
Endpoint String - The subscriber endpoint to which exception messages are posted.
- subscriber
Id String - The subscriber ID for the notification subscription.
Supporting Types
SubscriberNotificationConfiguration, SubscriberNotificationConfigurationArgs
- Https
Notification SubscriberConfiguration Notification Configuration Https Notification Configuration - The configurations for HTTPS subscriber notification.
- Sqs
Notification SubscriberConfiguration Notification Configuration Sqs Notification Configuration - The configurations for SQS subscriber notification.
There are no parameters within
sqs_notification_configuration
.
- Https
Notification SubscriberConfiguration Notification Configuration Https Notification Configuration - The configurations for HTTPS subscriber notification.
- Sqs
Notification SubscriberConfiguration Notification Configuration Sqs Notification Configuration - The configurations for SQS subscriber notification.
There are no parameters within
sqs_notification_configuration
.
- https
Notification SubscriberConfiguration Notification Configuration Https Notification Configuration - The configurations for HTTPS subscriber notification.
- sqs
Notification SubscriberConfiguration Notification Configuration Sqs Notification Configuration - The configurations for SQS subscriber notification.
There are no parameters within
sqs_notification_configuration
.
- https
Notification SubscriberConfiguration Notification Configuration Https Notification Configuration - The configurations for HTTPS subscriber notification.
- sqs
Notification SubscriberConfiguration Notification Configuration Sqs Notification Configuration - The configurations for SQS subscriber notification.
There are no parameters within
sqs_notification_configuration
.
- https_
notification_ Subscriberconfiguration Notification Configuration Https Notification Configuration - The configurations for HTTPS subscriber notification.
- sqs_
notification_ Subscriberconfiguration Notification Configuration Sqs Notification Configuration - The configurations for SQS subscriber notification.
There are no parameters within
sqs_notification_configuration
.
- https
Notification Property MapConfiguration - The configurations for HTTPS subscriber notification.
- sqs
Notification Property MapConfiguration - The configurations for SQS subscriber notification.
There are no parameters within
sqs_notification_configuration
.
SubscriberNotificationConfigurationHttpsNotificationConfiguration, SubscriberNotificationConfigurationHttpsNotificationConfigurationArgs
- Endpoint string
- The subscription endpoint in Security Lake. If you prefer notification with an HTTPS endpoint, populate this field.
- Target
Role stringArn - The Amazon Resource Name (ARN) of the EventBridge API destinations IAM role that you created. For more information about ARNs and how to use them in policies, see Managing data access and AWS Managed Policies in the Amazon Security Lake User Guide.
- string
- The API key name for the notification subscription.
- string
- The API key value for the notification subscription.
- Http
Method string - The HTTP method used for the notification subscription.
Valid values are
POST
andPUT
.
- Endpoint string
- The subscription endpoint in Security Lake. If you prefer notification with an HTTPS endpoint, populate this field.
- Target
Role stringArn - The Amazon Resource Name (ARN) of the EventBridge API destinations IAM role that you created. For more information about ARNs and how to use them in policies, see Managing data access and AWS Managed Policies in the Amazon Security Lake User Guide.
- string
- The API key name for the notification subscription.
- string
- The API key value for the notification subscription.
- Http
Method string - The HTTP method used for the notification subscription.
Valid values are
POST
andPUT
.
- endpoint String
- The subscription endpoint in Security Lake. If you prefer notification with an HTTPS endpoint, populate this field.
- target
Role StringArn - The Amazon Resource Name (ARN) of the EventBridge API destinations IAM role that you created. For more information about ARNs and how to use them in policies, see Managing data access and AWS Managed Policies in the Amazon Security Lake User Guide.
- String
- The API key name for the notification subscription.
- String
- The API key value for the notification subscription.
- http
Method String - The HTTP method used for the notification subscription.
Valid values are
POST
andPUT
.
- endpoint string
- The subscription endpoint in Security Lake. If you prefer notification with an HTTPS endpoint, populate this field.
- target
Role stringArn - The Amazon Resource Name (ARN) of the EventBridge API destinations IAM role that you created. For more information about ARNs and how to use them in policies, see Managing data access and AWS Managed Policies in the Amazon Security Lake User Guide.
- string
- The API key name for the notification subscription.
- string
- The API key value for the notification subscription.
- http
Method string - The HTTP method used for the notification subscription.
Valid values are
POST
andPUT
.
- endpoint str
- The subscription endpoint in Security Lake. If you prefer notification with an HTTPS endpoint, populate this field.
- target_
role_ strarn - The Amazon Resource Name (ARN) of the EventBridge API destinations IAM role that you created. For more information about ARNs and how to use them in policies, see Managing data access and AWS Managed Policies in the Amazon Security Lake User Guide.
- str
- The API key name for the notification subscription.
- str
- The API key value for the notification subscription.
- http_
method str - The HTTP method used for the notification subscription.
Valid values are
POST
andPUT
.
- endpoint String
- The subscription endpoint in Security Lake. If you prefer notification with an HTTPS endpoint, populate this field.
- target
Role StringArn - The Amazon Resource Name (ARN) of the EventBridge API destinations IAM role that you created. For more information about ARNs and how to use them in policies, see Managing data access and AWS Managed Policies in the Amazon Security Lake User Guide.
- String
- The API key name for the notification subscription.
- String
- The API key value for the notification subscription.
- http
Method String - The HTTP method used for the notification subscription.
Valid values are
POST
andPUT
.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.