aws-cdk-lib.aws_securitylake.CfnSubscriberNotification.HttpsNotificationConfigurationProperty

HttpsNotificationConfigurationProperty Struct

Specify the configurations you want to use for HTTPS subscriber notification.

Source

Generated code

Type last changed

v2.159.0 · 19 Sep 2024

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_securitylake as securitylake } from 'aws-cdk-lib';
const httpsNotificationConfigurationProperty: securitylake.CfnSubscriberNotification.HttpsNotificationConfigurationProperty = {
  endpoint: 'endpoint',
  targetRoleArn: 'targetRoleArn',

  // the properties below are optional
  authorizationApiKeyName: 'authorizationApiKeyName',
  authorizationApiKeyValue: 'authorizationApiKeyValue',
  httpMethod: 'httpMethod',
};

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_securitylake as securitylake

https_notification_configuration_property = securitylake.CfnSubscriberNotification.HttpsNotificationConfigurationProperty(
    endpoint="endpoint",
    target_role_arn="targetRoleArn",

    # the properties below are optional
    authorization_api_key_name="authorizationApiKeyName",
    authorization_api_key_value="authorizationApiKeyValue",
    http_method="httpMethod"
)

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.securitylake.*;

HttpsNotificationConfigurationProperty httpsNotificationConfigurationProperty = HttpsNotificationConfigurationProperty.builder()
        .endpoint("endpoint")
        .targetRoleArn("targetRoleArn")

        // the properties below are optional
        .authorizationApiKeyName("authorizationApiKeyName")
        .authorizationApiKeyValue("authorizationApiKeyValue")
        .httpMethod("httpMethod")
        .build();

// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.SecurityLake;

var httpsNotificationConfigurationProperty = new HttpsNotificationConfigurationProperty {
    Endpoint = "endpoint",
    TargetRoleArn = "targetRoleArn",

    // the properties below are optional
    AuthorizationApiKeyName = "authorizationApiKeyName",
    AuthorizationApiKeyValue = "authorizationApiKeyValue",
    HttpMethod = "httpMethod"
};

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

httpsNotificationConfigurationProperty := &HttpsNotificationConfigurationProperty{
	Endpoint: jsii.String("endpoint"),
	TargetRoleArn: jsii.String("targetRoleArn"),

	// the properties below are optional
	AuthorizationApiKeyName: jsii.String("authorizationApiKeyName"),
	AuthorizationApiKeyValue: jsii.String("authorizationApiKeyValue"),
	HttpMethod: jsii.String("httpMethod"),
}

Properties

authorizationApiKeyName?optionalstringauthorization_api_key_name?optionalstrauthorizationApiKeyName?optionalStringAuthorizationApiKeyName?optionalstringAuthorizationApiKeyName?optional*string#

The key name for the notification subscription.

authorizationApiKeyValue?optionalstringauthorization_api_key_value?optionalstrauthorizationApiKeyValue?optionalStringAuthorizationApiKeyValue?optionalstringAuthorizationApiKeyValue?optional*string#

The key value for the notification subscription.

endpointstringendpointstrendpointStringEndpointstringEndpoint*stringrequired#

The subscription endpoint in Security Lake .

If you prefer notification with an HTTPS endpoint, populate this field.

httpMethod?optionalstringhttp_method?optionalstrhttpMethod?optionalStringHttpMethod?optionalstringHttpMethod?optional*string#

The HTTPS method used for the notification subscription.

targetRoleArnstringtarget_role_arnstrtargetRoleArnStringTargetRoleArnstringTargetRoleArn*stringrequired#

The Amazon Resource Name (ARN) of the EventBridge API destinations IAM role that you created.

notes

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 .