com.amazonaws.services.identitymanagement.model.CreateOpenIDConnectProviderRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-iam Show documentation
/*
* Copyright 2010-2016 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.identitymanagement.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
*/
public class CreateOpenIDConnectProviderRequest extends AmazonWebServiceRequest
implements Serializable, Cloneable {
/**
*
* The URL of the identity provider. The URL must begin with "https://" and
* should correspond to the iss claim in the provider's OpenID
* Connect ID tokens. Per the OIDC standard, path components are allowed but
* query parameters are not. Typically the URL consists of only a host name,
* like "https://server.example.org" or "https://example.com".
*
*
* You cannot register the same provider multiple times in a single AWS
* account. If you try to submit a URL that has already been used for an
* OpenID Connect provider in the AWS account, you will get an error.
*
*/
private String url;
/**
*
* A list of client IDs (also known as audiences). When a mobile or web app
* registers with an OpenID Connect provider, they establish a value that
* identifies the application. (This is the value that's sent as the
* client_id parameter on OAuth requests.)
*
*
* You can register multiple client IDs with the same provider. For example,
* you might have multiple applications that use the same OIDC provider. You
* cannot register more than 100 client IDs with a single IAM OIDC provider.
*
*
* There is no defined format for a client ID. The
* CreateOpenIDConnectProviderRequest action accepts client IDs
* up to 255 characters long.
*
*/
private com.amazonaws.internal.SdkInternalList clientIDList;
/**
*
* A list of server certificate thumbprints for the OpenID Connect (OIDC)
* identity provider's server certificate(s). Typically this list includes
* only one entry. However, IAM lets you have up to five thumbprints for an
* OIDC provider. This lets you maintain multiple thumbprints if the
* identity provider is rotating certificates.
*
*
* The server certificate thumbprint is the hex-encoded SHA-1 hash value of
* the X.509 certificate used by the domain where the OpenID Connect
* provider makes its keys available. It is always a 40-character string.
*
*
* You must provide at least one thumbprint when creating an IAM OIDC
* provider. For example, if the OIDC provider is
* server.example.com and the provider stores its keys at
* "https://keys.server.example.com/openid-connect", the thumbprint string
* would be the hex-encoded SHA-1 hash value of the certificate used by
* https://keys.server.example.com.
*
*
* For more information about obtaining the OIDC provider's thumbprint, see
* Obtaining the Thumbprint for an OpenID Connect Provider in the
* IAM User Guide.
*
*/
private com.amazonaws.internal.SdkInternalList thumbprintList;
/**
*
* The URL of the identity provider. The URL must begin with "https://" and
* should correspond to the iss claim in the provider's OpenID
* Connect ID tokens. Per the OIDC standard, path components are allowed but
* query parameters are not. Typically the URL consists of only a host name,
* like "https://server.example.org" or "https://example.com".
*
*
* You cannot register the same provider multiple times in a single AWS
* account. If you try to submit a URL that has already been used for an
* OpenID Connect provider in the AWS account, you will get an error.
*
*
* @param url
* The URL of the identity provider. The URL must begin with
* "https://" and should correspond to the iss claim in
* the provider's OpenID Connect ID tokens. Per the OIDC standard,
* path components are allowed but query parameters are not.
* Typically the URL consists of only a host name, like
* "https://server.example.org" or "https://example.com".
*
* You cannot register the same provider multiple times in a single
* AWS account. If you try to submit a URL that has already been used
* for an OpenID Connect provider in the AWS account, you will get an
* error.
*/
public void setUrl(String url) {
this.url = url;
}
/**
*
* The URL of the identity provider. The URL must begin with "https://" and
* should correspond to the iss claim in the provider's OpenID
* Connect ID tokens. Per the OIDC standard, path components are allowed but
* query parameters are not. Typically the URL consists of only a host name,
* like "https://server.example.org" or "https://example.com".
*
*
* You cannot register the same provider multiple times in a single AWS
* account. If you try to submit a URL that has already been used for an
* OpenID Connect provider in the AWS account, you will get an error.
*
*
* @return The URL of the identity provider. The URL must begin with
* "https://" and should correspond to the iss claim in
* the provider's OpenID Connect ID tokens. Per the OIDC standard,
* path components are allowed but query parameters are not.
* Typically the URL consists of only a host name, like
* "https://server.example.org" or "https://example.com".
*
* You cannot register the same provider multiple times in a single
* AWS account. If you try to submit a URL that has already been
* used for an OpenID Connect provider in the AWS account, you will
* get an error.
*/
public String getUrl() {
return this.url;
}
/**
*
* The URL of the identity provider. The URL must begin with "https://" and
* should correspond to the iss claim in the provider's OpenID
* Connect ID tokens. Per the OIDC standard, path components are allowed but
* query parameters are not. Typically the URL consists of only a host name,
* like "https://server.example.org" or "https://example.com".
*
*
* You cannot register the same provider multiple times in a single AWS
* account. If you try to submit a URL that has already been used for an
* OpenID Connect provider in the AWS account, you will get an error.
*
*
* @param url
* The URL of the identity provider. The URL must begin with
* "https://" and should correspond to the iss claim in
* the provider's OpenID Connect ID tokens. Per the OIDC standard,
* path components are allowed but query parameters are not.
* Typically the URL consists of only a host name, like
* "https://server.example.org" or "https://example.com".
*
* You cannot register the same provider multiple times in a single
* AWS account. If you try to submit a URL that has already been used
* for an OpenID Connect provider in the AWS account, you will get an
* error.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateOpenIDConnectProviderRequest withUrl(String url) {
setUrl(url);
return this;
}
/**
*
* A list of client IDs (also known as audiences). When a mobile or web app
* registers with an OpenID Connect provider, they establish a value that
* identifies the application. (This is the value that's sent as the
* client_id parameter on OAuth requests.)
*
*
* You can register multiple client IDs with the same provider. For example,
* you might have multiple applications that use the same OIDC provider. You
* cannot register more than 100 client IDs with a single IAM OIDC provider.
*
*
* There is no defined format for a client ID. The
* CreateOpenIDConnectProviderRequest action accepts client IDs
* up to 255 characters long.
*
*
* @return A list of client IDs (also known as audiences). When a mobile or
* web app registers with an OpenID Connect provider, they establish
* a value that identifies the application. (This is the value
* that's sent as the client_id parameter on OAuth
* requests.)
*
* You can register multiple client IDs with the same provider. For
* example, you might have multiple applications that use the same
* OIDC provider. You cannot register more than 100 client IDs with
* a single IAM OIDC provider.
*
*
* There is no defined format for a client ID. The
* CreateOpenIDConnectProviderRequest action accepts
* client IDs up to 255 characters long.
*/
public java.util.List getClientIDList() {
if (clientIDList == null) {
clientIDList = new com.amazonaws.internal.SdkInternalList();
}
return clientIDList;
}
/**
*
* A list of client IDs (also known as audiences). When a mobile or web app
* registers with an OpenID Connect provider, they establish a value that
* identifies the application. (This is the value that's sent as the
* client_id parameter on OAuth requests.)
*
*
* You can register multiple client IDs with the same provider. For example,
* you might have multiple applications that use the same OIDC provider. You
* cannot register more than 100 client IDs with a single IAM OIDC provider.
*
*
* There is no defined format for a client ID. The
* CreateOpenIDConnectProviderRequest action accepts client IDs
* up to 255 characters long.
*
*
* @param clientIDList
* A list of client IDs (also known as audiences). When a mobile or
* web app registers with an OpenID Connect provider, they establish
* a value that identifies the application. (This is the value that's
* sent as the client_id parameter on OAuth
* requests.)
*
* You can register multiple client IDs with the same provider. For
* example, you might have multiple applications that use the same
* OIDC provider. You cannot register more than 100 client IDs with a
* single IAM OIDC provider.
*
*
* There is no defined format for a client ID. The
* CreateOpenIDConnectProviderRequest action accepts
* client IDs up to 255 characters long.
*/
public void setClientIDList(java.util.Collection clientIDList) {
if (clientIDList == null) {
this.clientIDList = null;
return;
}
this.clientIDList = new com.amazonaws.internal.SdkInternalList(
clientIDList);
}
/**
*
* A list of client IDs (also known as audiences). When a mobile or web app
* registers with an OpenID Connect provider, they establish a value that
* identifies the application. (This is the value that's sent as the
* client_id parameter on OAuth requests.)
*
*
* You can register multiple client IDs with the same provider. For example,
* you might have multiple applications that use the same OIDC provider. You
* cannot register more than 100 client IDs with a single IAM OIDC provider.
*
*
* There is no defined format for a client ID. The
* CreateOpenIDConnectProviderRequest action accepts client IDs
* up to 255 characters long.
*
*
* NOTE: This method appends the values to the existing list (if
* any). Use {@link #setClientIDList(java.util.Collection)} or
* {@link #withClientIDList(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param clientIDList
* A list of client IDs (also known as audiences). When a mobile or
* web app registers with an OpenID Connect provider, they establish
* a value that identifies the application. (This is the value that's
* sent as the client_id parameter on OAuth
* requests.)
*
* You can register multiple client IDs with the same provider. For
* example, you might have multiple applications that use the same
* OIDC provider. You cannot register more than 100 client IDs with a
* single IAM OIDC provider.
*
*
* There is no defined format for a client ID. The
* CreateOpenIDConnectProviderRequest action accepts
* client IDs up to 255 characters long.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateOpenIDConnectProviderRequest withClientIDList(
String... clientIDList) {
if (this.clientIDList == null) {
setClientIDList(new com.amazonaws.internal.SdkInternalList(
clientIDList.length));
}
for (String ele : clientIDList) {
this.clientIDList.add(ele);
}
return this;
}
/**
*
* A list of client IDs (also known as audiences). When a mobile or web app
* registers with an OpenID Connect provider, they establish a value that
* identifies the application. (This is the value that's sent as the
* client_id parameter on OAuth requests.)
*
*
* You can register multiple client IDs with the same provider. For example,
* you might have multiple applications that use the same OIDC provider. You
* cannot register more than 100 client IDs with a single IAM OIDC provider.
*
*
* There is no defined format for a client ID. The
* CreateOpenIDConnectProviderRequest action accepts client IDs
* up to 255 characters long.
*
*
* @param clientIDList
* A list of client IDs (also known as audiences). When a mobile or
* web app registers with an OpenID Connect provider, they establish
* a value that identifies the application. (This is the value that's
* sent as the client_id parameter on OAuth
* requests.)
*
* You can register multiple client IDs with the same provider. For
* example, you might have multiple applications that use the same
* OIDC provider. You cannot register more than 100 client IDs with a
* single IAM OIDC provider.
*
*
* There is no defined format for a client ID. The
* CreateOpenIDConnectProviderRequest action accepts
* client IDs up to 255 characters long.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateOpenIDConnectProviderRequest withClientIDList(
java.util.Collection clientIDList) {
setClientIDList(clientIDList);
return this;
}
/**
*
* A list of server certificate thumbprints for the OpenID Connect (OIDC)
* identity provider's server certificate(s). Typically this list includes
* only one entry. However, IAM lets you have up to five thumbprints for an
* OIDC provider. This lets you maintain multiple thumbprints if the
* identity provider is rotating certificates.
*
*
* The server certificate thumbprint is the hex-encoded SHA-1 hash value of
* the X.509 certificate used by the domain where the OpenID Connect
* provider makes its keys available. It is always a 40-character string.
*
*
* You must provide at least one thumbprint when creating an IAM OIDC
* provider. For example, if the OIDC provider is
* server.example.com and the provider stores its keys at
* "https://keys.server.example.com/openid-connect", the thumbprint string
* would be the hex-encoded SHA-1 hash value of the certificate used by
* https://keys.server.example.com.
*
*
* For more information about obtaining the OIDC provider's thumbprint, see
* Obtaining the Thumbprint for an OpenID Connect Provider in the
* IAM User Guide.
*
*
* @return A list of server certificate thumbprints for the OpenID Connect
* (OIDC) identity provider's server certificate(s). Typically this
* list includes only one entry. However, IAM lets you have up to
* five thumbprints for an OIDC provider. This lets you maintain
* multiple thumbprints if the identity provider is rotating
* certificates.
*
* The server certificate thumbprint is the hex-encoded SHA-1 hash
* value of the X.509 certificate used by the domain where the
* OpenID Connect provider makes its keys available. It is always a
* 40-character string.
*
*
* You must provide at least one thumbprint when creating an IAM
* OIDC provider. For example, if the OIDC provider is
* server.example.com and the provider stores its keys
* at "https://keys.server.example.com/openid-connect", the
* thumbprint string would be the hex-encoded SHA-1 hash value of
* the certificate used by https://keys.server.example.com.
*
*
* For more information about obtaining the OIDC provider's
* thumbprint, see Obtaining the Thumbprint for an OpenID Connect Provider in
* the IAM User Guide.
*/
public java.util.List getThumbprintList() {
if (thumbprintList == null) {
thumbprintList = new com.amazonaws.internal.SdkInternalList();
}
return thumbprintList;
}
/**
*
* A list of server certificate thumbprints for the OpenID Connect (OIDC)
* identity provider's server certificate(s). Typically this list includes
* only one entry. However, IAM lets you have up to five thumbprints for an
* OIDC provider. This lets you maintain multiple thumbprints if the
* identity provider is rotating certificates.
*
*
* The server certificate thumbprint is the hex-encoded SHA-1 hash value of
* the X.509 certificate used by the domain where the OpenID Connect
* provider makes its keys available. It is always a 40-character string.
*
*
* You must provide at least one thumbprint when creating an IAM OIDC
* provider. For example, if the OIDC provider is
* server.example.com and the provider stores its keys at
* "https://keys.server.example.com/openid-connect", the thumbprint string
* would be the hex-encoded SHA-1 hash value of the certificate used by
* https://keys.server.example.com.
*
*
* For more information about obtaining the OIDC provider's thumbprint, see
* Obtaining the Thumbprint for an OpenID Connect Provider in the
* IAM User Guide.
*
*
* @param thumbprintList
* A list of server certificate thumbprints for the OpenID Connect
* (OIDC) identity provider's server certificate(s). Typically this
* list includes only one entry. However, IAM lets you have up to
* five thumbprints for an OIDC provider. This lets you maintain
* multiple thumbprints if the identity provider is rotating
* certificates.
*
* The server certificate thumbprint is the hex-encoded SHA-1 hash
* value of the X.509 certificate used by the domain where the OpenID
* Connect provider makes its keys available. It is always a
* 40-character string.
*
*
* You must provide at least one thumbprint when creating an IAM OIDC
* provider. For example, if the OIDC provider is
* server.example.com and the provider stores its keys
* at "https://keys.server.example.com/openid-connect", the
* thumbprint string would be the hex-encoded SHA-1 hash value of the
* certificate used by https://keys.server.example.com.
*
*
* For more information about obtaining the OIDC provider's
* thumbprint, see Obtaining the Thumbprint for an OpenID Connect Provider in
* the IAM User Guide.
*/
public void setThumbprintList(java.util.Collection thumbprintList) {
if (thumbprintList == null) {
this.thumbprintList = null;
return;
}
this.thumbprintList = new com.amazonaws.internal.SdkInternalList(
thumbprintList);
}
/**
*
* A list of server certificate thumbprints for the OpenID Connect (OIDC)
* identity provider's server certificate(s). Typically this list includes
* only one entry. However, IAM lets you have up to five thumbprints for an
* OIDC provider. This lets you maintain multiple thumbprints if the
* identity provider is rotating certificates.
*
*
* The server certificate thumbprint is the hex-encoded SHA-1 hash value of
* the X.509 certificate used by the domain where the OpenID Connect
* provider makes its keys available. It is always a 40-character string.
*
*
* You must provide at least one thumbprint when creating an IAM OIDC
* provider. For example, if the OIDC provider is
* server.example.com and the provider stores its keys at
* "https://keys.server.example.com/openid-connect", the thumbprint string
* would be the hex-encoded SHA-1 hash value of the certificate used by
* https://keys.server.example.com.
*
*
* For more information about obtaining the OIDC provider's thumbprint, see
* Obtaining the Thumbprint for an OpenID Connect Provider in the
* IAM User Guide.
*
*
* NOTE: This method appends the values to the existing list (if
* any). Use {@link #setThumbprintList(java.util.Collection)} or
* {@link #withThumbprintList(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param thumbprintList
* A list of server certificate thumbprints for the OpenID Connect
* (OIDC) identity provider's server certificate(s). Typically this
* list includes only one entry. However, IAM lets you have up to
* five thumbprints for an OIDC provider. This lets you maintain
* multiple thumbprints if the identity provider is rotating
* certificates.
*
* The server certificate thumbprint is the hex-encoded SHA-1 hash
* value of the X.509 certificate used by the domain where the OpenID
* Connect provider makes its keys available. It is always a
* 40-character string.
*
*
* You must provide at least one thumbprint when creating an IAM OIDC
* provider. For example, if the OIDC provider is
* server.example.com and the provider stores its keys
* at "https://keys.server.example.com/openid-connect", the
* thumbprint string would be the hex-encoded SHA-1 hash value of the
* certificate used by https://keys.server.example.com.
*
*
* For more information about obtaining the OIDC provider's
* thumbprint, see Obtaining the Thumbprint for an OpenID Connect Provider in
* the IAM User Guide.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateOpenIDConnectProviderRequest withThumbprintList(
String... thumbprintList) {
if (this.thumbprintList == null) {
setThumbprintList(new com.amazonaws.internal.SdkInternalList(
thumbprintList.length));
}
for (String ele : thumbprintList) {
this.thumbprintList.add(ele);
}
return this;
}
/**
*
* A list of server certificate thumbprints for the OpenID Connect (OIDC)
* identity provider's server certificate(s). Typically this list includes
* only one entry. However, IAM lets you have up to five thumbprints for an
* OIDC provider. This lets you maintain multiple thumbprints if the
* identity provider is rotating certificates.
*
*
* The server certificate thumbprint is the hex-encoded SHA-1 hash value of
* the X.509 certificate used by the domain where the OpenID Connect
* provider makes its keys available. It is always a 40-character string.
*
*
* You must provide at least one thumbprint when creating an IAM OIDC
* provider. For example, if the OIDC provider is
* server.example.com and the provider stores its keys at
* "https://keys.server.example.com/openid-connect", the thumbprint string
* would be the hex-encoded SHA-1 hash value of the certificate used by
* https://keys.server.example.com.
*
*
* For more information about obtaining the OIDC provider's thumbprint, see
* Obtaining the Thumbprint for an OpenID Connect Provider in the
* IAM User Guide.
*
*
* @param thumbprintList
* A list of server certificate thumbprints for the OpenID Connect
* (OIDC) identity provider's server certificate(s). Typically this
* list includes only one entry. However, IAM lets you have up to
* five thumbprints for an OIDC provider. This lets you maintain
* multiple thumbprints if the identity provider is rotating
* certificates.
*
* The server certificate thumbprint is the hex-encoded SHA-1 hash
* value of the X.509 certificate used by the domain where the OpenID
* Connect provider makes its keys available. It is always a
* 40-character string.
*
*
* You must provide at least one thumbprint when creating an IAM OIDC
* provider. For example, if the OIDC provider is
* server.example.com and the provider stores its keys
* at "https://keys.server.example.com/openid-connect", the
* thumbprint string would be the hex-encoded SHA-1 hash value of the
* certificate used by https://keys.server.example.com.
*
*
* For more information about obtaining the OIDC provider's
* thumbprint, see Obtaining the Thumbprint for an OpenID Connect Provider in
* the IAM User Guide.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateOpenIDConnectProviderRequest withThumbprintList(
java.util.Collection thumbprintList) {
setThumbprintList(thumbprintList);
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getUrl() != null)
sb.append("Url: " + getUrl() + ",");
if (getClientIDList() != null)
sb.append("ClientIDList: " + getClientIDList() + ",");
if (getThumbprintList() != null)
sb.append("ThumbprintList: " + getThumbprintList());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateOpenIDConnectProviderRequest == false)
return false;
CreateOpenIDConnectProviderRequest other = (CreateOpenIDConnectProviderRequest) obj;
if (other.getUrl() == null ^ this.getUrl() == null)
return false;
if (other.getUrl() != null
&& other.getUrl().equals(this.getUrl()) == false)
return false;
if (other.getClientIDList() == null ^ this.getClientIDList() == null)
return false;
if (other.getClientIDList() != null
&& other.getClientIDList().equals(this.getClientIDList()) == false)
return false;
if (other.getThumbprintList() == null
^ this.getThumbprintList() == null)
return false;
if (other.getThumbprintList() != null
&& other.getThumbprintList().equals(this.getThumbprintList()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode
+ ((getUrl() == null) ? 0 : getUrl().hashCode());
hashCode = prime
* hashCode
+ ((getClientIDList() == null) ? 0 : getClientIDList()
.hashCode());
hashCode = prime
* hashCode
+ ((getThumbprintList() == null) ? 0 : getThumbprintList()
.hashCode());
return hashCode;
}
@Override
public CreateOpenIDConnectProviderRequest clone() {
return (CreateOpenIDConnectProviderRequest) super.clone();
}
}