com.amazonaws.services.lambda.model.SourceAccessConfiguration Maven / Gradle / Ivy
Show all versions of aws-java-sdk-lambda Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.lambda.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* To secure and define access to your event source, you can specify the authentication protocol, VPC components, or
* virtual host.
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class SourceAccessConfiguration implements Serializable, Cloneable, StructuredPojo {
/**
*
* 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.
*
*
*
*/
private String type;
/**
*
* The value for your chosen configuration in Type. For example:
* "URI": "arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName".
*
*/
private String uRI;
/**
*
* 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.
*
*
*
*
* @param 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.
*
*
* @see SourceAccessType
*/
public void setType(String type) {
this.type = 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.
*
*
*
*
* @return 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.
*
*
* @see SourceAccessType
*/
public String getType() {
return this.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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see SourceAccessType
*/
public SourceAccessConfiguration withType(String type) {
setType(type);
return this;
}
/**
*
* 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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see SourceAccessType
*/
public SourceAccessConfiguration withType(SourceAccessType type) {
this.type = type.toString();
return this;
}
/**
*
* The value for your chosen configuration in Type. For example:
* "URI": "arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName".
*
*
* @param uRI
* The value for your chosen configuration in Type. For example:
* "URI": "arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName".
*/
public void setURI(String uRI) {
this.uRI = uRI;
}
/**
*
* The value for your chosen configuration in Type. For example:
* "URI": "arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName".
*
*
* @return The value for your chosen configuration in Type. For example:
* "URI": "arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName".
*/
public String getURI() {
return this.uRI;
}
/**
*
* The value for your chosen configuration in Type. For example:
* "URI": "arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName".
*
*
* @param uRI
* The value for your chosen configuration in Type. For example:
* "URI": "arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName".
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SourceAccessConfiguration withURI(String uRI) {
setURI(uRI);
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getType() != null)
sb.append("Type: ").append(getType()).append(",");
if (getURI() != null)
sb.append("URI: ").append(getURI());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof SourceAccessConfiguration == false)
return false;
SourceAccessConfiguration other = (SourceAccessConfiguration) obj;
if (other.getType() == null ^ this.getType() == null)
return false;
if (other.getType() != null && other.getType().equals(this.getType()) == false)
return false;
if (other.getURI() == null ^ this.getURI() == null)
return false;
if (other.getURI() != null && other.getURI().equals(this.getURI()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getType() == null) ? 0 : getType().hashCode());
hashCode = prime * hashCode + ((getURI() == null) ? 0 : getURI().hashCode());
return hashCode;
}
@Override
public SourceAccessConfiguration clone() {
try {
return (SourceAccessConfiguration) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.lambda.model.transform.SourceAccessConfigurationMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}