amazonka-lambda-2.0: Amazon Lambda SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Lambda.Types.SourceAccessConfiguration

Description

 
Synopsis

Documentation

data SourceAccessConfiguration Source #

To secure and define access to your event source, you can specify the authentication protocol, VPC components, or virtual host.

See: newSourceAccessConfiguration smart constructor.

Constructors

SourceAccessConfiguration' 

Fields

  • type' :: Maybe SourceAccessType

    The type of authentication protocol, VPC components, or virtual host for your event source. For example: "Type":"SASL_SCRAM_512_AUTH".

    • BASIC_AUTH - (Amazon MQ) The Secrets Manager secret that stores your broker credentials.
    • BASIC_AUTH - (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL/PLAIN authentication of your Apache Kafka brokers.
    • VPC_SUBNET - (Self-managed Apache Kafka) The subnets associated with your VPC. Lambda connects to these subnets to fetch data from your self-managed Apache Kafka cluster.
    • VPC_SECURITY_GROUP - (Self-managed Apache Kafka) The VPC security group used to manage access to your self-managed Apache Kafka brokers.
    • SASL_SCRAM_256_AUTH - (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-256 authentication of your self-managed Apache Kafka brokers.
    • SASL_SCRAM_512_AUTH - (Amazon MSK, Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-512 authentication of your self-managed Apache Kafka brokers.
    • VIRTUAL_HOST - (RabbitMQ) The name of the virtual host in your RabbitMQ broker. Lambda uses this RabbitMQ host as the event source. This property cannot be specified in an UpdateEventSourceMapping API call.
    • CLIENT_CERTIFICATE_TLS_AUTH - (Amazon MSK, self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the certificate chain (X.509 PEM), private key (PKCS#8 PEM), and private key password (optional) used for mutual TLS authentication of your MSK/Apache Kafka brokers.
    • SERVER_ROOT_CA_CERTIFICATE - (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the root CA certificate (X.509 PEM) used for TLS encryption of your Apache Kafka brokers.
  • uri :: Maybe Text

    The value for your chosen configuration in Type. For example: "URI": "arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName".

Instances

Instances details
FromJSON SourceAccessConfiguration Source # 
Instance details

Defined in Amazonka.Lambda.Types.SourceAccessConfiguration

Methods

parseJSON :: Value -> Parser SourceAccessConfiguration #

parseJSONList :: Value -> Parser [SourceAccessConfiguration] #

ToJSON SourceAccessConfiguration Source # 
Instance details

Defined in Amazonka.Lambda.Types.SourceAccessConfiguration

Methods

toJSON :: SourceAccessConfiguration -> Value #

toEncoding :: SourceAccessConfiguration -> Encoding #

toJSONList :: [SourceAccessConfiguration] -> Value #

toEncodingList :: [SourceAccessConfiguration] -> Encoding #

Generic SourceAccessConfiguration Source # 
Instance details

Defined in Amazonka.Lambda.Types.SourceAccessConfiguration

Associated Types

type Rep SourceAccessConfiguration :: Type -> Type #

Methods

from :: SourceAccessConfiguration -> Rep SourceAccessConfiguration x #

to :: Rep SourceAccessConfiguration x -> SourceAccessConfiguration #

Read SourceAccessConfiguration Source # 
Instance details

Defined in Amazonka.Lambda.Types.SourceAccessConfiguration

Methods

readsPrec :: Int -> ReadS SourceAccessConfiguration #

readList :: ReadS [SourceAccessConfiguration] #

readPrec :: ReadPrec SourceAccessConfiguration #

readListPrec :: ReadPrec [SourceAccessConfiguration] #

Show SourceAccessConfiguration Source # 
Instance details

Defined in Amazonka.Lambda.Types.SourceAccessConfiguration

Methods

showsPrec :: Int -> SourceAccessConfiguration -> ShowS #

show :: SourceAccessConfiguration -> String #

showList :: [SourceAccessConfiguration] -> ShowS #

NFData SourceAccessConfiguration Source # 
Instance details

Defined in Amazonka.Lambda.Types.SourceAccessConfiguration

Methods

rnf :: SourceAccessConfiguration -> () #

Eq SourceAccessConfiguration Source # 
Instance details

Defined in Amazonka.Lambda.Types.SourceAccessConfiguration

Methods

(==) :: SourceAccessConfiguration -> SourceAccessConfiguration -> Bool #

(/=) :: SourceAccessConfiguration -> SourceAccessConfiguration -> Bool #

Hashable SourceAccessConfiguration Source # 
Instance details

Defined in Amazonka.Lambda.Types.SourceAccessConfiguration

Methods

hashWithSalt :: Int -> SourceAccessConfiguration -> Int #

hash :: SourceAccessConfiguration -> Int #

type Rep SourceAccessConfiguration Source # 
Instance details

Defined in Amazonka.Lambda.Types.SourceAccessConfiguration

type Rep SourceAccessConfiguration = D1 ('MetaData "SourceAccessConfiguration" "Amazonka.Lambda.Types.SourceAccessConfiguration" "amazonka-lambda-2.0-FcjxCCKaCGK94C2lDO9alC" 'False) (C1 ('MetaCons "SourceAccessConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SourceAccessType)) :*: S1 ('MetaSel ('Just "uri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newSourceAccessConfiguration :: SourceAccessConfiguration Source #

Create a value of SourceAccessConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:type':SourceAccessConfiguration', sourceAccessConfiguration_type - The type of authentication protocol, VPC components, or virtual host for your event source. For example: "Type":"SASL_SCRAM_512_AUTH".

  • BASIC_AUTH - (Amazon MQ) The Secrets Manager secret that stores your broker credentials.
  • BASIC_AUTH - (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL/PLAIN authentication of your Apache Kafka brokers.
  • VPC_SUBNET - (Self-managed Apache Kafka) The subnets associated with your VPC. Lambda connects to these subnets to fetch data from your self-managed Apache Kafka cluster.
  • VPC_SECURITY_GROUP - (Self-managed Apache Kafka) The VPC security group used to manage access to your self-managed Apache Kafka brokers.
  • SASL_SCRAM_256_AUTH - (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-256 authentication of your self-managed Apache Kafka brokers.
  • SASL_SCRAM_512_AUTH - (Amazon MSK, Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-512 authentication of your self-managed Apache Kafka brokers.
  • VIRTUAL_HOST - (RabbitMQ) The name of the virtual host in your RabbitMQ broker. Lambda uses this RabbitMQ host as the event source. This property cannot be specified in an UpdateEventSourceMapping API call.
  • CLIENT_CERTIFICATE_TLS_AUTH - (Amazon MSK, self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the certificate chain (X.509 PEM), private key (PKCS#8 PEM), and private key password (optional) used for mutual TLS authentication of your MSK/Apache Kafka brokers.
  • SERVER_ROOT_CA_CERTIFICATE - (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the root CA certificate (X.509 PEM) used for TLS encryption of your Apache Kafka brokers.

$sel:uri:SourceAccessConfiguration', sourceAccessConfiguration_uri - The value for your chosen configuration in Type. For example: "URI": "arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName".

sourceAccessConfiguration_type :: Lens' SourceAccessConfiguration (Maybe SourceAccessType) Source #

The type of authentication protocol, VPC components, or virtual host for your event source. For example: "Type":"SASL_SCRAM_512_AUTH".

  • BASIC_AUTH - (Amazon MQ) The Secrets Manager secret that stores your broker credentials.
  • BASIC_AUTH - (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL/PLAIN authentication of your Apache Kafka brokers.
  • VPC_SUBNET - (Self-managed Apache Kafka) The subnets associated with your VPC. Lambda connects to these subnets to fetch data from your self-managed Apache Kafka cluster.
  • VPC_SECURITY_GROUP - (Self-managed Apache Kafka) The VPC security group used to manage access to your self-managed Apache Kafka brokers.
  • SASL_SCRAM_256_AUTH - (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-256 authentication of your self-managed Apache Kafka brokers.
  • SASL_SCRAM_512_AUTH - (Amazon MSK, Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-512 authentication of your self-managed Apache Kafka brokers.
  • VIRTUAL_HOST - (RabbitMQ) The name of the virtual host in your RabbitMQ broker. Lambda uses this RabbitMQ host as the event source. This property cannot be specified in an UpdateEventSourceMapping API call.
  • CLIENT_CERTIFICATE_TLS_AUTH - (Amazon MSK, self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the certificate chain (X.509 PEM), private key (PKCS#8 PEM), and private key password (optional) used for mutual TLS authentication of your MSK/Apache Kafka brokers.
  • SERVER_ROOT_CA_CERTIFICATE - (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the root CA certificate (X.509 PEM) used for TLS encryption of your Apache Kafka brokers.

sourceAccessConfiguration_uri :: Lens' SourceAccessConfiguration (Maybe Text) Source #

The value for your chosen configuration in Type. For example: "URI": "arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName".