com.amazonaws.services.verifiedpermissions.model.ConfigurationDetail Maven / Gradle / Ivy
Show all versions of aws-java-sdk-verifiedpermissions 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.verifiedpermissions.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Contains configuration information about an identity source.
*
*
* This data type is a response parameter to the GetIdentitySource operation.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ConfigurationDetail implements Serializable, Cloneable, StructuredPojo {
/**
*
* Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of
* authenticated identities as entities. It specifies the Amazon Resource Name (ARN)
* of a Amazon Cognito user pool, the policy store entity that you want to assign to user groups, and one or more
* application client IDs.
*
*
* Example:
* "configuration":{"cognitoUserPoolConfiguration":{"userPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","clientIds": ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration": {"groupEntityType": "MyCorp::Group"}}}
*
*/
private CognitoUserPoolConfigurationDetail cognitoUserPoolConfiguration;
/**
*
* Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that Verified
* Permissions can use to generate entities from authenticated identities. It specifies the issuer URL, token type
* that you want to use, and policy store entity details.
*
*
* Example:
* "configuration":{"openIdConnectConfiguration":{"issuer":"https://auth.example.com","tokenSelection":{"accessTokenOnly":{"audiences":["https://myapp.example.com","https://myapp2.example.com"],"principalIdClaim":"sub"}},"entityIdPrefix":"MyOIDCProvider","groupConfiguration":{"groupClaim":"groups","groupEntityType":"MyCorp::UserGroup"}}}
*
*/
private OpenIdConnectConfigurationDetail openIdConnectConfiguration;
/**
*
* Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of
* authenticated identities as entities. It specifies the Amazon Resource Name (ARN)
* of a Amazon Cognito user pool, the policy store entity that you want to assign to user groups, and one or more
* application client IDs.
*
*
* Example:
* "configuration":{"cognitoUserPoolConfiguration":{"userPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","clientIds": ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration": {"groupEntityType": "MyCorp::Group"}}}
*
*
* @param cognitoUserPoolConfiguration
* Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source
* of authenticated identities as entities. It specifies the Amazon Resource Name
* (ARN) of a Amazon Cognito user pool, the policy store entity that you want to assign to user groups,
* and one or more application client IDs.
*
* Example:
* "configuration":{"cognitoUserPoolConfiguration":{"userPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","clientIds": ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration": {"groupEntityType": "MyCorp::Group"}}}
*/
public void setCognitoUserPoolConfiguration(CognitoUserPoolConfigurationDetail cognitoUserPoolConfiguration) {
this.cognitoUserPoolConfiguration = cognitoUserPoolConfiguration;
}
/**
*
* Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of
* authenticated identities as entities. It specifies the Amazon Resource Name (ARN)
* of a Amazon Cognito user pool, the policy store entity that you want to assign to user groups, and one or more
* application client IDs.
*
*
* Example:
* "configuration":{"cognitoUserPoolConfiguration":{"userPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","clientIds": ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration": {"groupEntityType": "MyCorp::Group"}}}
*
*
* @return Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a
* source of authenticated identities as entities. It specifies the Amazon Resource Name
* (ARN) of a Amazon Cognito user pool, the policy store entity that you want to assign to user groups,
* and one or more application client IDs.
*
* Example:
* "configuration":{"cognitoUserPoolConfiguration":{"userPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","clientIds": ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration": {"groupEntityType": "MyCorp::Group"}}}
*/
public CognitoUserPoolConfigurationDetail getCognitoUserPoolConfiguration() {
return this.cognitoUserPoolConfiguration;
}
/**
*
* Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of
* authenticated identities as entities. It specifies the Amazon Resource Name (ARN)
* of a Amazon Cognito user pool, the policy store entity that you want to assign to user groups, and one or more
* application client IDs.
*
*
* Example:
* "configuration":{"cognitoUserPoolConfiguration":{"userPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","clientIds": ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration": {"groupEntityType": "MyCorp::Group"}}}
*
*
* @param cognitoUserPoolConfiguration
* Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source
* of authenticated identities as entities. It specifies the Amazon Resource Name
* (ARN) of a Amazon Cognito user pool, the policy store entity that you want to assign to user groups,
* and one or more application client IDs.
*
* Example:
* "configuration":{"cognitoUserPoolConfiguration":{"userPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","clientIds": ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration": {"groupEntityType": "MyCorp::Group"}}}
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ConfigurationDetail withCognitoUserPoolConfiguration(CognitoUserPoolConfigurationDetail cognitoUserPoolConfiguration) {
setCognitoUserPoolConfiguration(cognitoUserPoolConfiguration);
return this;
}
/**
*
* Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that Verified
* Permissions can use to generate entities from authenticated identities. It specifies the issuer URL, token type
* that you want to use, and policy store entity details.
*
*
* Example:
* "configuration":{"openIdConnectConfiguration":{"issuer":"https://auth.example.com","tokenSelection":{"accessTokenOnly":{"audiences":["https://myapp.example.com","https://myapp2.example.com"],"principalIdClaim":"sub"}},"entityIdPrefix":"MyOIDCProvider","groupConfiguration":{"groupClaim":"groups","groupEntityType":"MyCorp::UserGroup"}}}
*
*
* @param openIdConnectConfiguration
* Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that
* Verified Permissions can use to generate entities from authenticated identities. It specifies the issuer
* URL, token type that you want to use, and policy store entity details.
*
* Example:
* "configuration":{"openIdConnectConfiguration":{"issuer":"https://auth.example.com","tokenSelection":{"accessTokenOnly":{"audiences":["https://myapp.example.com","https://myapp2.example.com"],"principalIdClaim":"sub"}},"entityIdPrefix":"MyOIDCProvider","groupConfiguration":{"groupClaim":"groups","groupEntityType":"MyCorp::UserGroup"}}}
*/
public void setOpenIdConnectConfiguration(OpenIdConnectConfigurationDetail openIdConnectConfiguration) {
this.openIdConnectConfiguration = openIdConnectConfiguration;
}
/**
*
* Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that Verified
* Permissions can use to generate entities from authenticated identities. It specifies the issuer URL, token type
* that you want to use, and policy store entity details.
*
*
* Example:
* "configuration":{"openIdConnectConfiguration":{"issuer":"https://auth.example.com","tokenSelection":{"accessTokenOnly":{"audiences":["https://myapp.example.com","https://myapp2.example.com"],"principalIdClaim":"sub"}},"entityIdPrefix":"MyOIDCProvider","groupConfiguration":{"groupClaim":"groups","groupEntityType":"MyCorp::UserGroup"}}}
*
*
* @return Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that
* Verified Permissions can use to generate entities from authenticated identities. It specifies the issuer
* URL, token type that you want to use, and policy store entity details.
*
* Example:
* "configuration":{"openIdConnectConfiguration":{"issuer":"https://auth.example.com","tokenSelection":{"accessTokenOnly":{"audiences":["https://myapp.example.com","https://myapp2.example.com"],"principalIdClaim":"sub"}},"entityIdPrefix":"MyOIDCProvider","groupConfiguration":{"groupClaim":"groups","groupEntityType":"MyCorp::UserGroup"}}}
*/
public OpenIdConnectConfigurationDetail getOpenIdConnectConfiguration() {
return this.openIdConnectConfiguration;
}
/**
*
* Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that Verified
* Permissions can use to generate entities from authenticated identities. It specifies the issuer URL, token type
* that you want to use, and policy store entity details.
*
*
* Example:
* "configuration":{"openIdConnectConfiguration":{"issuer":"https://auth.example.com","tokenSelection":{"accessTokenOnly":{"audiences":["https://myapp.example.com","https://myapp2.example.com"],"principalIdClaim":"sub"}},"entityIdPrefix":"MyOIDCProvider","groupConfiguration":{"groupClaim":"groups","groupEntityType":"MyCorp::UserGroup"}}}
*
*
* @param openIdConnectConfiguration
* Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that
* Verified Permissions can use to generate entities from authenticated identities. It specifies the issuer
* URL, token type that you want to use, and policy store entity details.
*
* Example:
* "configuration":{"openIdConnectConfiguration":{"issuer":"https://auth.example.com","tokenSelection":{"accessTokenOnly":{"audiences":["https://myapp.example.com","https://myapp2.example.com"],"principalIdClaim":"sub"}},"entityIdPrefix":"MyOIDCProvider","groupConfiguration":{"groupClaim":"groups","groupEntityType":"MyCorp::UserGroup"}}}
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ConfigurationDetail withOpenIdConnectConfiguration(OpenIdConnectConfigurationDetail openIdConnectConfiguration) {
setOpenIdConnectConfiguration(openIdConnectConfiguration);
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 (getCognitoUserPoolConfiguration() != null)
sb.append("CognitoUserPoolConfiguration: ").append(getCognitoUserPoolConfiguration()).append(",");
if (getOpenIdConnectConfiguration() != null)
sb.append("OpenIdConnectConfiguration: ").append(getOpenIdConnectConfiguration());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ConfigurationDetail == false)
return false;
ConfigurationDetail other = (ConfigurationDetail) obj;
if (other.getCognitoUserPoolConfiguration() == null ^ this.getCognitoUserPoolConfiguration() == null)
return false;
if (other.getCognitoUserPoolConfiguration() != null && other.getCognitoUserPoolConfiguration().equals(this.getCognitoUserPoolConfiguration()) == false)
return false;
if (other.getOpenIdConnectConfiguration() == null ^ this.getOpenIdConnectConfiguration() == null)
return false;
if (other.getOpenIdConnectConfiguration() != null && other.getOpenIdConnectConfiguration().equals(this.getOpenIdConnectConfiguration()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getCognitoUserPoolConfiguration() == null) ? 0 : getCognitoUserPoolConfiguration().hashCode());
hashCode = prime * hashCode + ((getOpenIdConnectConfiguration() == null) ? 0 : getOpenIdConnectConfiguration().hashCode());
return hashCode;
}
@Override
public ConfigurationDetail clone() {
try {
return (ConfigurationDetail) 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.verifiedpermissions.model.transform.ConfigurationDetailMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}