AWS SDK for C++  1.9.14
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::IAM::Model::CreateOpenIDConnectProviderRequest Class Reference

#include <CreateOpenIDConnectProviderRequest.h>

+ Inheritance diagram for Aws::IAM::Model::CreateOpenIDConnectProviderRequest:

Public Member Functions

 CreateOpenIDConnectProviderRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetUrl () const
 
bool UrlHasBeenSet () const
 
void SetUrl (const Aws::String &value)
 
void SetUrl (Aws::String &&value)
 
void SetUrl (const char *value)
 
CreateOpenIDConnectProviderRequestWithUrl (const Aws::String &value)
 
CreateOpenIDConnectProviderRequestWithUrl (Aws::String &&value)
 
CreateOpenIDConnectProviderRequestWithUrl (const char *value)
 
const Aws::Vector< Aws::String > & GetClientIDList () const
 
bool ClientIDListHasBeenSet () const
 
void SetClientIDList (const Aws::Vector< Aws::String > &value)
 
void SetClientIDList (Aws::Vector< Aws::String > &&value)
 
CreateOpenIDConnectProviderRequestWithClientIDList (const Aws::Vector< Aws::String > &value)
 
CreateOpenIDConnectProviderRequestWithClientIDList (Aws::Vector< Aws::String > &&value)
 
CreateOpenIDConnectProviderRequestAddClientIDList (const Aws::String &value)
 
CreateOpenIDConnectProviderRequestAddClientIDList (Aws::String &&value)
 
CreateOpenIDConnectProviderRequestAddClientIDList (const char *value)
 
const Aws::Vector< Aws::String > & GetThumbprintList () const
 
bool ThumbprintListHasBeenSet () const
 
void SetThumbprintList (const Aws::Vector< Aws::String > &value)
 
void SetThumbprintList (Aws::Vector< Aws::String > &&value)
 
CreateOpenIDConnectProviderRequestWithThumbprintList (const Aws::Vector< Aws::String > &value)
 
CreateOpenIDConnectProviderRequestWithThumbprintList (Aws::Vector< Aws::String > &&value)
 
CreateOpenIDConnectProviderRequestAddThumbprintList (const Aws::String &value)
 
CreateOpenIDConnectProviderRequestAddThumbprintList (Aws::String &&value)
 
CreateOpenIDConnectProviderRequestAddThumbprintList (const char *value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
CreateOpenIDConnectProviderRequestWithTags (const Aws::Vector< Tag > &value)
 
CreateOpenIDConnectProviderRequestWithTags (Aws::Vector< Tag > &&value)
 
CreateOpenIDConnectProviderRequestAddTags (const Tag &value)
 
CreateOpenIDConnectProviderRequestAddTags (Tag &&value)
 
- Public Member Functions inherited from Aws::IAM::IAMRequest
virtual ~IAMRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::IAM::IAMRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

Definition at line 23 of file CreateOpenIDConnectProviderRequest.h.

Constructor & Destructor Documentation

◆ CreateOpenIDConnectProviderRequest()

Aws::IAM::Model::CreateOpenIDConnectProviderRequest::CreateOpenIDConnectProviderRequest ( )

Member Function Documentation

◆ AddClientIDList() [1/3]

CreateOpenIDConnectProviderRequest& Aws::IAM::Model::CreateOpenIDConnectProviderRequest::AddClientIDList ( Aws::String &&  value)
inline

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 operation accepts client IDs up to 255 characters long.

Definition at line 248 of file CreateOpenIDConnectProviderRequest.h.

◆ AddClientIDList() [2/3]

CreateOpenIDConnectProviderRequest& Aws::IAM::Model::CreateOpenIDConnectProviderRequest::AddClientIDList ( const Aws::String value)
inline

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 operation accepts client IDs up to 255 characters long.

Definition at line 235 of file CreateOpenIDConnectProviderRequest.h.

◆ AddClientIDList() [3/3]

CreateOpenIDConnectProviderRequest& Aws::IAM::Model::CreateOpenIDConnectProviderRequest::AddClientIDList ( const char *  value)
inline

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 operation accepts client IDs up to 255 characters long.

Definition at line 261 of file CreateOpenIDConnectProviderRequest.h.

◆ AddTags() [1/2]

CreateOpenIDConnectProviderRequest& Aws::IAM::Model::CreateOpenIDConnectProviderRequest::AddTags ( const Tag value)
inline

A list of tags that you want to attach to the new IAM OpenID Connect (OIDC) provider. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

Definition at line 529 of file CreateOpenIDConnectProviderRequest.h.

◆ AddTags() [2/2]

CreateOpenIDConnectProviderRequest& Aws::IAM::Model::CreateOpenIDConnectProviderRequest::AddTags ( Tag &&  value)
inline

A list of tags that you want to attach to the new IAM OpenID Connect (OIDC) provider. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

Definition at line 540 of file CreateOpenIDConnectProviderRequest.h.

◆ AddThumbprintList() [1/3]

CreateOpenIDConnectProviderRequest& Aws::IAM::Model::CreateOpenIDConnectProviderRequest::AddThumbprintList ( Aws::String &&  value)
inline

A list of server certificate thumbprints for the OpenID Connect (OIDC) identity provider's server certificates. 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, assume that the OIDC provider is server.example.com and the provider stores its keys at https://keys.server.example.com/openid-connect. In that case, 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.

Definition at line 430 of file CreateOpenIDConnectProviderRequest.h.

◆ AddThumbprintList() [2/3]

CreateOpenIDConnectProviderRequest& Aws::IAM::Model::CreateOpenIDConnectProviderRequest::AddThumbprintList ( const Aws::String value)
inline

A list of server certificate thumbprints for the OpenID Connect (OIDC) identity provider's server certificates. 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, assume that the OIDC provider is server.example.com and the provider stores its keys at https://keys.server.example.com/openid-connect. In that case, 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.

Definition at line 409 of file CreateOpenIDConnectProviderRequest.h.

◆ AddThumbprintList() [3/3]

CreateOpenIDConnectProviderRequest& Aws::IAM::Model::CreateOpenIDConnectProviderRequest::AddThumbprintList ( const char *  value)
inline

A list of server certificate thumbprints for the OpenID Connect (OIDC) identity provider's server certificates. 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, assume that the OIDC provider is server.example.com and the provider stores its keys at https://keys.server.example.com/openid-connect. In that case, 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.

Definition at line 451 of file CreateOpenIDConnectProviderRequest.h.

◆ ClientIDListHasBeenSet()

bool Aws::IAM::Model::CreateOpenIDConnectProviderRequest::ClientIDListHasBeenSet ( ) const
inline

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 operation accepts client IDs up to 255 characters long.

Definition at line 170 of file CreateOpenIDConnectProviderRequest.h.

◆ DumpBodyToUrl()

void Aws::IAM::Model::CreateOpenIDConnectProviderRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ GetClientIDList()

const Aws::Vector<Aws::String>& Aws::IAM::Model::CreateOpenIDConnectProviderRequest::GetClientIDList ( ) const
inline

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 operation accepts client IDs up to 255 characters long.

Definition at line 157 of file CreateOpenIDConnectProviderRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::IAM::Model::CreateOpenIDConnectProviderRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file CreateOpenIDConnectProviderRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::IAM::Model::CreateOpenIDConnectProviderRequest::GetTags ( ) const
inline

A list of tags that you want to attach to the new IAM OpenID Connect (OIDC) provider. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

Definition at line 463 of file CreateOpenIDConnectProviderRequest.h.

◆ GetThumbprintList()

const Aws::Vector<Aws::String>& Aws::IAM::Model::CreateOpenIDConnectProviderRequest::GetThumbprintList ( ) const
inline

A list of server certificate thumbprints for the OpenID Connect (OIDC) identity provider's server certificates. 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, assume that the OIDC provider is server.example.com and the provider stores its keys at https://keys.server.example.com/openid-connect. In that case, 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.

Definition at line 283 of file CreateOpenIDConnectProviderRequest.h.

◆ GetUrl()

const Aws::String& Aws::IAM::Model::CreateOpenIDConnectProviderRequest::GetUrl ( ) const
inline

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 hostname, 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.

Definition at line 52 of file CreateOpenIDConnectProviderRequest.h.

◆ SerializePayload()

Aws::String Aws::IAM::Model::CreateOpenIDConnectProviderRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClientIDList() [1/2]

void Aws::IAM::Model::CreateOpenIDConnectProviderRequest::SetClientIDList ( Aws::Vector< Aws::String > &&  value)
inline

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 operation accepts client IDs up to 255 characters long.

Definition at line 196 of file CreateOpenIDConnectProviderRequest.h.

◆ SetClientIDList() [2/2]

void Aws::IAM::Model::CreateOpenIDConnectProviderRequest::SetClientIDList ( const Aws::Vector< Aws::String > &  value)
inline

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 operation accepts client IDs up to 255 characters long.

Definition at line 183 of file CreateOpenIDConnectProviderRequest.h.

◆ SetTags() [1/2]

void Aws::IAM::Model::CreateOpenIDConnectProviderRequest::SetTags ( Aws::Vector< Tag > &&  value)
inline

A list of tags that you want to attach to the new IAM OpenID Connect (OIDC) provider. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

Definition at line 496 of file CreateOpenIDConnectProviderRequest.h.

◆ SetTags() [2/2]

void Aws::IAM::Model::CreateOpenIDConnectProviderRequest::SetTags ( const Aws::Vector< Tag > &  value)
inline

A list of tags that you want to attach to the new IAM OpenID Connect (OIDC) provider. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

Definition at line 485 of file CreateOpenIDConnectProviderRequest.h.

◆ SetThumbprintList() [1/2]

void Aws::IAM::Model::CreateOpenIDConnectProviderRequest::SetThumbprintList ( Aws::Vector< Aws::String > &&  value)
inline

A list of server certificate thumbprints for the OpenID Connect (OIDC) identity provider's server certificates. 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, assume that the OIDC provider is server.example.com and the provider stores its keys at https://keys.server.example.com/openid-connect. In that case, 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.

Definition at line 346 of file CreateOpenIDConnectProviderRequest.h.

◆ SetThumbprintList() [2/2]

void Aws::IAM::Model::CreateOpenIDConnectProviderRequest::SetThumbprintList ( const Aws::Vector< Aws::String > &  value)
inline

A list of server certificate thumbprints for the OpenID Connect (OIDC) identity provider's server certificates. 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, assume that the OIDC provider is server.example.com and the provider stores its keys at https://keys.server.example.com/openid-connect. In that case, 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.

Definition at line 325 of file CreateOpenIDConnectProviderRequest.h.

◆ SetUrl() [1/3]

void Aws::IAM::Model::CreateOpenIDConnectProviderRequest::SetUrl ( Aws::String &&  value)
inline

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 hostname, 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.

Definition at line 91 of file CreateOpenIDConnectProviderRequest.h.

◆ SetUrl() [2/3]

void Aws::IAM::Model::CreateOpenIDConnectProviderRequest::SetUrl ( const Aws::String value)
inline

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 hostname, 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.

Definition at line 78 of file CreateOpenIDConnectProviderRequest.h.

◆ SetUrl() [3/3]

void Aws::IAM::Model::CreateOpenIDConnectProviderRequest::SetUrl ( const char *  value)
inline

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 hostname, 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.

Definition at line 104 of file CreateOpenIDConnectProviderRequest.h.

◆ TagsHasBeenSet()

bool Aws::IAM::Model::CreateOpenIDConnectProviderRequest::TagsHasBeenSet ( ) const
inline

A list of tags that you want to attach to the new IAM OpenID Connect (OIDC) provider. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

Definition at line 474 of file CreateOpenIDConnectProviderRequest.h.

◆ ThumbprintListHasBeenSet()

bool Aws::IAM::Model::CreateOpenIDConnectProviderRequest::ThumbprintListHasBeenSet ( ) const
inline

A list of server certificate thumbprints for the OpenID Connect (OIDC) identity provider's server certificates. 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, assume that the OIDC provider is server.example.com and the provider stores its keys at https://keys.server.example.com/openid-connect. In that case, 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.

Definition at line 304 of file CreateOpenIDConnectProviderRequest.h.

◆ UrlHasBeenSet()

bool Aws::IAM::Model::CreateOpenIDConnectProviderRequest::UrlHasBeenSet ( ) const
inline

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 hostname, 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.

Definition at line 65 of file CreateOpenIDConnectProviderRequest.h.

◆ WithClientIDList() [1/2]

CreateOpenIDConnectProviderRequest& Aws::IAM::Model::CreateOpenIDConnectProviderRequest::WithClientIDList ( Aws::Vector< Aws::String > &&  value)
inline

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 operation accepts client IDs up to 255 characters long.

Definition at line 222 of file CreateOpenIDConnectProviderRequest.h.

◆ WithClientIDList() [2/2]

CreateOpenIDConnectProviderRequest& Aws::IAM::Model::CreateOpenIDConnectProviderRequest::WithClientIDList ( const Aws::Vector< Aws::String > &  value)
inline

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 operation accepts client IDs up to 255 characters long.

Definition at line 209 of file CreateOpenIDConnectProviderRequest.h.

◆ WithTags() [1/2]

CreateOpenIDConnectProviderRequest& Aws::IAM::Model::CreateOpenIDConnectProviderRequest::WithTags ( Aws::Vector< Tag > &&  value)
inline

A list of tags that you want to attach to the new IAM OpenID Connect (OIDC) provider. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

Definition at line 518 of file CreateOpenIDConnectProviderRequest.h.

◆ WithTags() [2/2]

CreateOpenIDConnectProviderRequest& Aws::IAM::Model::CreateOpenIDConnectProviderRequest::WithTags ( const Aws::Vector< Tag > &  value)
inline

A list of tags that you want to attach to the new IAM OpenID Connect (OIDC) provider. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

Definition at line 507 of file CreateOpenIDConnectProviderRequest.h.

◆ WithThumbprintList() [1/2]

CreateOpenIDConnectProviderRequest& Aws::IAM::Model::CreateOpenIDConnectProviderRequest::WithThumbprintList ( Aws::Vector< Aws::String > &&  value)
inline

A list of server certificate thumbprints for the OpenID Connect (OIDC) identity provider's server certificates. 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, assume that the OIDC provider is server.example.com and the provider stores its keys at https://keys.server.example.com/openid-connect. In that case, 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.

Definition at line 388 of file CreateOpenIDConnectProviderRequest.h.

◆ WithThumbprintList() [2/2]

CreateOpenIDConnectProviderRequest& Aws::IAM::Model::CreateOpenIDConnectProviderRequest::WithThumbprintList ( const Aws::Vector< Aws::String > &  value)
inline

A list of server certificate thumbprints for the OpenID Connect (OIDC) identity provider's server certificates. 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, assume that the OIDC provider is server.example.com and the provider stores its keys at https://keys.server.example.com/openid-connect. In that case, 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.

Definition at line 367 of file CreateOpenIDConnectProviderRequest.h.

◆ WithUrl() [1/3]

CreateOpenIDConnectProviderRequest& Aws::IAM::Model::CreateOpenIDConnectProviderRequest::WithUrl ( Aws::String &&  value)
inline

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 hostname, 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.

Definition at line 130 of file CreateOpenIDConnectProviderRequest.h.

◆ WithUrl() [2/3]

CreateOpenIDConnectProviderRequest& Aws::IAM::Model::CreateOpenIDConnectProviderRequest::WithUrl ( const Aws::String value)
inline

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 hostname, 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.

Definition at line 117 of file CreateOpenIDConnectProviderRequest.h.

◆ WithUrl() [3/3]

CreateOpenIDConnectProviderRequest& Aws::IAM::Model::CreateOpenIDConnectProviderRequest::WithUrl ( const char *  value)
inline

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 hostname, 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.

Definition at line 143 of file CreateOpenIDConnectProviderRequest.h.


The documentation for this class was generated from the following file: