public class EventSourceConfiguration extends Object implements Serializable
Describes mapping between an Amazon Kinesis stream and a Lambda function.
Constructor and Description |
---|
EventSourceConfiguration() |
Modifier and Type | Method and Description |
---|---|
EventSourceConfiguration |
addParametersEntry(String key,
String value)
The map (key-value pairs) defining the configuration for AWS Lambda to
use when reading the event source.
|
EventSourceConfiguration |
clearParametersEntries()
Removes all the entries added into Parameters.
|
boolean |
equals(Object obj) |
Integer |
getBatchSize()
The largest number of records that AWS Lambda will POST in the
invocation request to your function.
|
String |
getEventSource()
The Amazon Resource Name (ARN) of the Amazon Kinesis stream that is
the source of events.
|
String |
getFunctionName()
The Lambda function to invoke when AWS Lambda detects an event on the
stream.
|
String |
getIsActive()
Indicates whether the event source mapping is currently honored.
|
String |
getLastModified()
The UTC time string indicating the last time the event mapping was
updated.
|
Map<String,String> |
getParameters()
The map (key-value pairs) defining the configuration for AWS Lambda to
use when reading the event source.
|
String |
getRole()
The ARN of the IAM role (invocation role) that AWS Lambda can assume
to read from the stream and invoke the function.
|
String |
getStatus()
The description of the health of the event source mapping.
|
String |
getUUID()
The AWS Lambda assigned opaque identifier for the mapping.
|
int |
hashCode() |
void |
setBatchSize(Integer batchSize)
The largest number of records that AWS Lambda will POST in the
invocation request to your function.
|
void |
setEventSource(String eventSource)
The Amazon Resource Name (ARN) of the Amazon Kinesis stream that is
the source of events.
|
void |
setFunctionName(String functionName)
The Lambda function to invoke when AWS Lambda detects an event on the
stream.
|
void |
setIsActive(String isActive)
Indicates whether the event source mapping is currently honored.
|
void |
setLastModified(String lastModified)
The UTC time string indicating the last time the event mapping was
updated.
|
void |
setParameters(Map<String,String> parameters)
The map (key-value pairs) defining the configuration for AWS Lambda to
use when reading the event source.
|
void |
setRole(String role)
The ARN of the IAM role (invocation role) that AWS Lambda can assume
to read from the stream and invoke the function.
|
void |
setStatus(String status)
The description of the health of the event source mapping.
|
void |
setUUID(String uUID)
The AWS Lambda assigned opaque identifier for the mapping.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
EventSourceConfiguration |
withBatchSize(Integer batchSize)
The largest number of records that AWS Lambda will POST in the
invocation request to your function.
|
EventSourceConfiguration |
withEventSource(String eventSource)
The Amazon Resource Name (ARN) of the Amazon Kinesis stream that is
the source of events.
|
EventSourceConfiguration |
withFunctionName(String functionName)
The Lambda function to invoke when AWS Lambda detects an event on the
stream.
|
EventSourceConfiguration |
withIsActive(String isActive)
Indicates whether the event source mapping is currently honored.
|
EventSourceConfiguration |
withLastModified(String lastModified)
The UTC time string indicating the last time the event mapping was
updated.
|
EventSourceConfiguration |
withParameters(Map<String,String> parameters)
The map (key-value pairs) defining the configuration for AWS Lambda to
use when reading the event source.
|
EventSourceConfiguration |
withRole(String role)
The ARN of the IAM role (invocation role) that AWS Lambda can assume
to read from the stream and invoke the function.
|
EventSourceConfiguration |
withStatus(String status)
The description of the health of the event source mapping.
|
EventSourceConfiguration |
withUUID(String uUID)
The AWS Lambda assigned opaque identifier for the mapping.
|
public String getUUID()
public void setUUID(String uUID)
uUID
- The AWS Lambda assigned opaque identifier for the mapping.public EventSourceConfiguration withUUID(String uUID)
Returns a reference to this object so that method calls can be chained together.
uUID
- The AWS Lambda assigned opaque identifier for the mapping.public Integer getBatchSize()
public void setBatchSize(Integer batchSize)
batchSize
- The largest number of records that AWS Lambda will POST in the
invocation request to your function.public EventSourceConfiguration withBatchSize(Integer batchSize)
Returns a reference to this object so that method calls can be chained together.
batchSize
- The largest number of records that AWS Lambda will POST in the
invocation request to your function.public String getEventSource()
public void setEventSource(String eventSource)
eventSource
- The Amazon Resource Name (ARN) of the Amazon Kinesis stream that is
the source of events.public EventSourceConfiguration withEventSource(String eventSource)
Returns a reference to this object so that method calls can be chained together.
eventSource
- The Amazon Resource Name (ARN) of the Amazon Kinesis stream that is
the source of events.public String getFunctionName()
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9-]+
public void setFunctionName(String functionName)
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9-]+
functionName
- The Lambda function to invoke when AWS Lambda detects an event on the
stream.public EventSourceConfiguration withFunctionName(String functionName)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9-]+
functionName
- The Lambda function to invoke when AWS Lambda detects an event on the
stream.public Map<String,String> getParameters()
public void setParameters(Map<String,String> parameters)
parameters
- The map (key-value pairs) defining the configuration for AWS Lambda to
use when reading the event source.public EventSourceConfiguration withParameters(Map<String,String> parameters)
Returns a reference to this object so that method calls can be chained together.
parameters
- The map (key-value pairs) defining the configuration for AWS Lambda to
use when reading the event source.public EventSourceConfiguration addParametersEntry(String key, String value)
The method adds a new key-value pair into Parameters parameter, and returns a reference to this object so that method calls can be chained together.
key
- The key of the entry to be added into Parameters.value
- The corresponding value of the entry to be added into Parameters.public EventSourceConfiguration clearParametersEntries()
Returns a reference to this object so that method calls can be chained together.
public String getRole()
Constraints:
Pattern: arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_]+
public void setRole(String role)
Constraints:
Pattern: arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_]+
role
- The ARN of the IAM role (invocation role) that AWS Lambda can assume
to read from the stream and invoke the function.public EventSourceConfiguration withRole(String role)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Pattern: arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_]+
role
- The ARN of the IAM role (invocation role) that AWS Lambda can assume
to read from the stream and invoke the function.public String getLastModified()
public void setLastModified(String lastModified)
lastModified
- The UTC time string indicating the last time the event mapping was
updated.public EventSourceConfiguration withLastModified(String lastModified)
Returns a reference to this object so that method calls can be chained together.
lastModified
- The UTC time string indicating the last time the event mapping was
updated.public String getIsActive()
public void setIsActive(String isActive)
isActive
- Indicates whether the event source mapping is currently honored.
Events are only processes if IsActive is true.public EventSourceConfiguration withIsActive(String isActive)
Returns a reference to this object so that method calls can be chained together.
isActive
- Indicates whether the event source mapping is currently honored.
Events are only processes if IsActive is true.public String getStatus()
public void setStatus(String status)
status
- The description of the health of the event source mapping. Valid
values are: "PENDING", "OK", and "PROBLEM:message". Initially
this staus is "PENDING". When AWS Lambda begins processing events, it
changes the status to "OK".public EventSourceConfiguration withStatus(String status)
Returns a reference to this object so that method calls can be chained together.
status
- The description of the health of the event source mapping. Valid
values are: "PENDING", "OK", and "PROBLEM:message". Initially
this staus is "PENDING". When AWS Lambda begins processing events, it
changes the status to "OK".public String toString()
toString
in class Object
Object.toString()
Copyright © 2015. All rights reserved.