software.aws.awsprototypingsdk.openapigateway.CognitoAuthorizerProps Maven / Gradle / Ivy
Show all versions of open-api-gateway Show documentation
package software.aws.awsprototypingsdk.openapigateway;
/**
* (experimental) Properties used to configure a cognito authorizer.
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.82.0 (build 2d2ddd7)", date = "2023-08-15T05:38:04.569Z")
@software.amazon.jsii.Jsii(module = software.aws.awsprototypingsdk.openapigateway.$Module.class, fqn = "@aws-prototyping-sdk/open-api-gateway.CognitoAuthorizerProps")
@software.amazon.jsii.Jsii.Proxy(CognitoAuthorizerProps.Jsii$Proxy.class)
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public interface CognitoAuthorizerProps extends software.amazon.jsii.JsiiSerializable {
/**
* (experimental) Unique identifier for this authorizer.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@org.jetbrains.annotations.NotNull java.lang.String getAuthorizerId();
/**
* (experimental) The Cognito user pools associated with this authorizer.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@org.jetbrains.annotations.NotNull java.util.List getUserPools();
/**
* (experimental) A list of authorization scopes configured on the method.
*
* When used as the default authorizer, these scopes will be
* applied to all methods without an authorizer at the integration level.
*
* Default: []
*
* @see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizationscopes
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
default @org.jetbrains.annotations.Nullable java.util.List getAuthorizationScopes() {
return null;
}
/**
* @return a {@link Builder} of {@link CognitoAuthorizerProps}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
static Builder builder() {
return new Builder();
}
/**
* A builder for {@link CognitoAuthorizerProps}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static final class Builder implements software.amazon.jsii.Builder {
java.lang.String authorizerId;
java.util.List userPools;
java.util.List authorizationScopes;
/**
* Sets the value of {@link CognitoAuthorizerProps#getAuthorizerId}
* @param authorizerId Unique identifier for this authorizer. This parameter is required.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder authorizerId(java.lang.String authorizerId) {
this.authorizerId = authorizerId;
return this;
}
/**
* Sets the value of {@link CognitoAuthorizerProps#getUserPools}
* @param userPools The Cognito user pools associated with this authorizer. This parameter is required.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@SuppressWarnings("unchecked")
public Builder userPools(java.util.List userPools) {
this.userPools = (java.util.List)userPools;
return this;
}
/**
* Sets the value of {@link CognitoAuthorizerProps#getAuthorizationScopes}
* @param authorizationScopes A list of authorization scopes configured on the method.
* When used as the default authorizer, these scopes will be
* applied to all methods without an authorizer at the integration level.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder authorizationScopes(java.util.List authorizationScopes) {
this.authorizationScopes = authorizationScopes;
return this;
}
/**
* Builds the configured instance.
* @return a new instance of {@link CognitoAuthorizerProps}
* @throws NullPointerException if any required attribute was not provided
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public CognitoAuthorizerProps build() {
return new Jsii$Proxy(this);
}
}
/**
* An implementation for {@link CognitoAuthorizerProps}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@software.amazon.jsii.Internal
final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CognitoAuthorizerProps {
private final java.lang.String authorizerId;
private final java.util.List userPools;
private final java.util.List authorizationScopes;
/**
* Constructor that initializes the object based on values retrieved from the JsiiObject.
* @param objRef Reference to the JSII managed object.
*/
protected Jsii$Proxy(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
this.authorizerId = software.amazon.jsii.Kernel.get(this, "authorizerId", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.userPools = software.amazon.jsii.Kernel.get(this, "userPools", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.cognito.IUserPool.class)));
this.authorizationScopes = software.amazon.jsii.Kernel.get(this, "authorizationScopes", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(java.lang.String.class)));
}
/**
* Constructor that initializes the object based on literal property values passed by the {@link Builder}.
*/
@SuppressWarnings("unchecked")
protected Jsii$Proxy(final Builder builder) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
this.authorizerId = java.util.Objects.requireNonNull(builder.authorizerId, "authorizerId is required");
this.userPools = (java.util.List)java.util.Objects.requireNonNull(builder.userPools, "userPools is required");
this.authorizationScopes = builder.authorizationScopes;
}
@Override
public final java.lang.String getAuthorizerId() {
return this.authorizerId;
}
@Override
public final java.util.List getUserPools() {
return this.userPools;
}
@Override
public final java.util.List getAuthorizationScopes() {
return this.authorizationScopes;
}
@Override
@software.amazon.jsii.Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson() {
final com.fasterxml.jackson.databind.ObjectMapper om = software.amazon.jsii.JsiiObjectMapper.INSTANCE;
final com.fasterxml.jackson.databind.node.ObjectNode data = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
data.set("authorizerId", om.valueToTree(this.getAuthorizerId()));
data.set("userPools", om.valueToTree(this.getUserPools()));
if (this.getAuthorizationScopes() != null) {
data.set("authorizationScopes", om.valueToTree(this.getAuthorizationScopes()));
}
final com.fasterxml.jackson.databind.node.ObjectNode struct = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
struct.set("fqn", om.valueToTree("@aws-prototyping-sdk/open-api-gateway.CognitoAuthorizerProps"));
struct.set("data", data);
final com.fasterxml.jackson.databind.node.ObjectNode obj = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
obj.set("$jsii.struct", struct);
return obj;
}
@Override
public final boolean equals(final Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
CognitoAuthorizerProps.Jsii$Proxy that = (CognitoAuthorizerProps.Jsii$Proxy) o;
if (!authorizerId.equals(that.authorizerId)) return false;
if (!userPools.equals(that.userPools)) return false;
return this.authorizationScopes != null ? this.authorizationScopes.equals(that.authorizationScopes) : that.authorizationScopes == null;
}
@Override
public final int hashCode() {
int result = this.authorizerId.hashCode();
result = 31 * result + (this.userPools.hashCode());
result = 31 * result + (this.authorizationScopes != null ? this.authorizationScopes.hashCode() : 0);
return result;
}
}
}