Package software.amazon.awsconstructs.services.lambdasns

Interface LambdaToSnsProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
LambdaToSnsProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.102.0 (build e354887)", date="2024-08-26T23:34:12.793Z") public interface LambdaToSnsProps extends software.amazon.jsii.JsiiSerializable

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final class 
    LambdaToSnsProps.Builder
    A builder for LambdaToSnsProps
    static final class 
    LambdaToSnsProps.Jsii$Proxy
    An implementation for LambdaToSnsProps

  • Method Summary

    Modifier and Type
    Method
    Description
    static LambdaToSnsProps.Builder
    builder()
     
    default Boolean
    getDeployVpc()
    Whether to deploy a new VPC.
    default Boolean
    getEnableEncryptionWithCustomerManagedKey()
    If no key is provided, this flag determines whether the SNS Topic is encrypted with a new CMK or an AWS managed key.
    default software.amazon.awscdk.services.kms.Key
    getEncryptionKey()
    An optional, imported encryption key to encrypt the SNS Topic with.
    default software.amazon.awscdk.services.kms.KeyProps
    getEncryptionKeyProps()
    Optional user provided properties to override the default properties for the KMS encryption key used to encrypt the SNS Topic with.
    default software.amazon.awscdk.services.lambda.Function
    getExistingLambdaObj()
    Existing instance of Lambda Function object, providing both this and lambdaFunctionProps will cause an error.
    default software.amazon.awscdk.services.sns.Topic
    getExistingTopicObj()
    Existing instance of SNS Topic object, providing both this and topicProps will cause an error..
    default software.amazon.awscdk.services.ec2.IVpc
    getExistingVpc()
    An existing VPC for the construct to use (construct will NOT create a new VPC in this case).
    default software.amazon.awscdk.services.lambda.FunctionProps
    getLambdaFunctionProps()
    User provided props to override the default props for the Lambda function.
    default String
    getTopicArnEnvironmentVariableName()
    Optional Name for the Lambda function environment variable set to the arn of the Topic.
    default String
    getTopicNameEnvironmentVariableName()
    Optional Name for the Lambda function environment variable set to the name of the Topic.
    default software.amazon.awscdk.services.sns.TopicProps
    getTopicProps()
    Optional user provided properties to override the default properties for the SNS topic.
    default software.amazon.awscdk.services.ec2.VpcProps
    getVpcProps()
    Properties to override default properties if deployVpc is true.

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Method Details

    • getDeployVpc

      @Nullable default Boolean getDeployVpc()
      Whether to deploy a new VPC.

      Default: - false

    • getEnableEncryptionWithCustomerManagedKey

      @Nullable default Boolean getEnableEncryptionWithCustomerManagedKey()
      If no key is provided, this flag determines whether the SNS Topic is encrypted with a new CMK or an AWS managed key.

      This flag is ignored if any of the following are defined: topicProps.masterKey, encryptionKey or encryptionKeyProps.

      Default: - False if topicProps.masterKey, encryptionKey, and encryptionKeyProps are all undefined.

    • getEncryptionKey

      @Nullable default software.amazon.awscdk.services.kms.Key getEncryptionKey()
      An optional, imported encryption key to encrypt the SNS Topic with.

      Default: - None

    • getEncryptionKeyProps

      @Nullable default software.amazon.awscdk.services.kms.KeyProps getEncryptionKeyProps()
      Optional user provided properties to override the default properties for the KMS encryption key used to encrypt the SNS Topic with.

      Default: - None

    • getExistingLambdaObj

      @Nullable default software.amazon.awscdk.services.lambda.Function getExistingLambdaObj()
      Existing instance of Lambda Function object, providing both this and lambdaFunctionProps will cause an error.

      Default: - None

    • getExistingTopicObj

      @Nullable default software.amazon.awscdk.services.sns.Topic getExistingTopicObj()
      Existing instance of SNS Topic object, providing both this and topicProps will cause an error..

      Default: - Default props are used

    • getExistingVpc

      @Nullable default software.amazon.awscdk.services.ec2.IVpc getExistingVpc()
      An existing VPC for the construct to use (construct will NOT create a new VPC in this case).

    • getLambdaFunctionProps

      @Nullable default software.amazon.awscdk.services.lambda.FunctionProps getLambdaFunctionProps()
      User provided props to override the default props for the Lambda function.

      Default: - Default properties are used.

    • getTopicArnEnvironmentVariableName

      @Nullable default String getTopicArnEnvironmentVariableName()
      Optional Name for the Lambda function environment variable set to the arn of the Topic.

      Default: - SNS_TOPIC_ARN

    • getTopicNameEnvironmentVariableName

      @Nullable default String getTopicNameEnvironmentVariableName()
      Optional Name for the Lambda function environment variable set to the name of the Topic.

      Default: - SNS_TOPIC_NAME

    • getTopicProps

      @Nullable default software.amazon.awscdk.services.sns.TopicProps getTopicProps()
      Optional user provided properties to override the default properties for the SNS topic.

      Default: - Default properties are used.

    • getVpcProps

      @Nullable default software.amazon.awscdk.services.ec2.VpcProps getVpcProps()
      Properties to override default properties if deployVpc is true.

    • builder

      static LambdaToSnsProps.Builder builder()
      Returns:
      a LambdaToSnsProps.Builder of LambdaToSnsProps