Class CognitoOptions
java.lang.Object
software.amazon.awssdk.services.elasticsearch.model.CognitoOptions
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<CognitoOptions.Builder,
CognitoOptions>
@Generated("software.amazon.awssdk:codegen")
public final class CognitoOptions
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CognitoOptions.Builder,CognitoOptions>
Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic CognitoOptions.Builder
builder()
final Boolean
enabled()
Specifies the option to enable Cognito for Kibana authentication.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
Specifies the Cognito identity pool ID for Kibana authentication.final String
roleArn()
Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.static Class
<? extends CognitoOptions.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
Specifies the Cognito user pool ID for Kibana authentication.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
enabled
Specifies the option to enable Cognito for Kibana authentication.
- Returns:
- Specifies the option to enable Cognito for Kibana authentication.
-
userPoolId
Specifies the Cognito user pool ID for Kibana authentication.
- Returns:
- Specifies the Cognito user pool ID for Kibana authentication.
-
identityPoolId
Specifies the Cognito identity pool ID for Kibana authentication.
- Returns:
- Specifies the Cognito identity pool ID for Kibana authentication.
-
roleArn
Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.
- Returns:
- Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CognitoOptions.Builder,
CognitoOptions> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
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. -
getValueForField
-
sdkFields
-