This repository has been archived on 2025-09-14. You can view files and clone it, but cannot push or open issues or pull requests.
Files
pxz-hos-client-cpp-module/support/aws-sdk-cpp-master/aws-cpp-sdk-iam/include/aws/iam/model/CreateSAMLProviderRequest.h

212 lines
11 KiB
C
Raw Normal View History

/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/iam/IAM_EXPORTS.h>
#include <aws/iam/IAMRequest.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <utility>
namespace Aws
{
namespace IAM
{
namespace Model
{
/**
*/
class AWS_IAM_API CreateSAMLProviderRequest : public IAMRequest
{
public:
CreateSAMLProviderRequest();
// Service request name is the Operation name which will send this request out,
// each operation should has unique request name, so that we can get operation's name from this request.
// Note: this is not true for response, multiple operations may have the same response name,
// so we can not get operation's name from response.
inline virtual const char* GetServiceRequestName() const override { return "CreateSAMLProvider"; }
Aws::String SerializePayload() const override;
protected:
void DumpBodyToUrl(Aws::Http::URI& uri ) const override;
public:
/**
* <p>An XML document generated by an identity provider (IdP) that supports SAML
* 2.0. The document includes the issuer's name, expiration information, and keys
* that can be used to validate the SAML authentication response (assertions) that
* are received from the IdP. You must generate the metadata document using the
* identity management software that is used as your organization's IdP.</p> <p>For
* more information, see <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html">About
* SAML 2.0-based Federation</a> in the <i>IAM User Guide</i> </p>
*/
inline const Aws::String& GetSAMLMetadataDocument() const{ return m_sAMLMetadataDocument; }
/**
* <p>An XML document generated by an identity provider (IdP) that supports SAML
* 2.0. The document includes the issuer's name, expiration information, and keys
* that can be used to validate the SAML authentication response (assertions) that
* are received from the IdP. You must generate the metadata document using the
* identity management software that is used as your organization's IdP.</p> <p>For
* more information, see <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html">About
* SAML 2.0-based Federation</a> in the <i>IAM User Guide</i> </p>
*/
inline bool SAMLMetadataDocumentHasBeenSet() const { return m_sAMLMetadataDocumentHasBeenSet; }
/**
* <p>An XML document generated by an identity provider (IdP) that supports SAML
* 2.0. The document includes the issuer's name, expiration information, and keys
* that can be used to validate the SAML authentication response (assertions) that
* are received from the IdP. You must generate the metadata document using the
* identity management software that is used as your organization's IdP.</p> <p>For
* more information, see <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html">About
* SAML 2.0-based Federation</a> in the <i>IAM User Guide</i> </p>
*/
inline void SetSAMLMetadataDocument(const Aws::String& value) { m_sAMLMetadataDocumentHasBeenSet = true; m_sAMLMetadataDocument = value; }
/**
* <p>An XML document generated by an identity provider (IdP) that supports SAML
* 2.0. The document includes the issuer's name, expiration information, and keys
* that can be used to validate the SAML authentication response (assertions) that
* are received from the IdP. You must generate the metadata document using the
* identity management software that is used as your organization's IdP.</p> <p>For
* more information, see <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html">About
* SAML 2.0-based Federation</a> in the <i>IAM User Guide</i> </p>
*/
inline void SetSAMLMetadataDocument(Aws::String&& value) { m_sAMLMetadataDocumentHasBeenSet = true; m_sAMLMetadataDocument = std::move(value); }
/**
* <p>An XML document generated by an identity provider (IdP) that supports SAML
* 2.0. The document includes the issuer's name, expiration information, and keys
* that can be used to validate the SAML authentication response (assertions) that
* are received from the IdP. You must generate the metadata document using the
* identity management software that is used as your organization's IdP.</p> <p>For
* more information, see <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html">About
* SAML 2.0-based Federation</a> in the <i>IAM User Guide</i> </p>
*/
inline void SetSAMLMetadataDocument(const char* value) { m_sAMLMetadataDocumentHasBeenSet = true; m_sAMLMetadataDocument.assign(value); }
/**
* <p>An XML document generated by an identity provider (IdP) that supports SAML
* 2.0. The document includes the issuer's name, expiration information, and keys
* that can be used to validate the SAML authentication response (assertions) that
* are received from the IdP. You must generate the metadata document using the
* identity management software that is used as your organization's IdP.</p> <p>For
* more information, see <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html">About
* SAML 2.0-based Federation</a> in the <i>IAM User Guide</i> </p>
*/
inline CreateSAMLProviderRequest& WithSAMLMetadataDocument(const Aws::String& value) { SetSAMLMetadataDocument(value); return *this;}
/**
* <p>An XML document generated by an identity provider (IdP) that supports SAML
* 2.0. The document includes the issuer's name, expiration information, and keys
* that can be used to validate the SAML authentication response (assertions) that
* are received from the IdP. You must generate the metadata document using the
* identity management software that is used as your organization's IdP.</p> <p>For
* more information, see <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html">About
* SAML 2.0-based Federation</a> in the <i>IAM User Guide</i> </p>
*/
inline CreateSAMLProviderRequest& WithSAMLMetadataDocument(Aws::String&& value) { SetSAMLMetadataDocument(std::move(value)); return *this;}
/**
* <p>An XML document generated by an identity provider (IdP) that supports SAML
* 2.0. The document includes the issuer's name, expiration information, and keys
* that can be used to validate the SAML authentication response (assertions) that
* are received from the IdP. You must generate the metadata document using the
* identity management software that is used as your organization's IdP.</p> <p>For
* more information, see <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html">About
* SAML 2.0-based Federation</a> in the <i>IAM User Guide</i> </p>
*/
inline CreateSAMLProviderRequest& WithSAMLMetadataDocument(const char* value) { SetSAMLMetadataDocument(value); return *this;}
/**
* <p>The name of the provider to create.</p> <p>This parameter allows (through its
* <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a string of
* characters consisting of upper and lowercase alphanumeric characters with no
* spaces. You can also include any of the following characters: _+=,.@-</p>
*/
inline const Aws::String& GetName() const{ return m_name; }
/**
* <p>The name of the provider to create.</p> <p>This parameter allows (through its
* <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a string of
* characters consisting of upper and lowercase alphanumeric characters with no
* spaces. You can also include any of the following characters: _+=,.@-</p>
*/
inline bool NameHasBeenSet() const { return m_nameHasBeenSet; }
/**
* <p>The name of the provider to create.</p> <p>This parameter allows (through its
* <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a string of
* characters consisting of upper and lowercase alphanumeric characters with no
* spaces. You can also include any of the following characters: _+=,.@-</p>
*/
inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; }
/**
* <p>The name of the provider to create.</p> <p>This parameter allows (through its
* <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a string of
* characters consisting of upper and lowercase alphanumeric characters with no
* spaces. You can also include any of the following characters: _+=,.@-</p>
*/
inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); }
/**
* <p>The name of the provider to create.</p> <p>This parameter allows (through its
* <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a string of
* characters consisting of upper and lowercase alphanumeric characters with no
* spaces. You can also include any of the following characters: _+=,.@-</p>
*/
inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); }
/**
* <p>The name of the provider to create.</p> <p>This parameter allows (through its
* <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a string of
* characters consisting of upper and lowercase alphanumeric characters with no
* spaces. You can also include any of the following characters: _+=,.@-</p>
*/
inline CreateSAMLProviderRequest& WithName(const Aws::String& value) { SetName(value); return *this;}
/**
* <p>The name of the provider to create.</p> <p>This parameter allows (through its
* <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a string of
* characters consisting of upper and lowercase alphanumeric characters with no
* spaces. You can also include any of the following characters: _+=,.@-</p>
*/
inline CreateSAMLProviderRequest& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;}
/**
* <p>The name of the provider to create.</p> <p>This parameter allows (through its
* <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a string of
* characters consisting of upper and lowercase alphanumeric characters with no
* spaces. You can also include any of the following characters: _+=,.@-</p>
*/
inline CreateSAMLProviderRequest& WithName(const char* value) { SetName(value); return *this;}
private:
Aws::String m_sAMLMetadataDocument;
bool m_sAMLMetadataDocumentHasBeenSet;
Aws::String m_name;
bool m_nameHasBeenSet;
};
} // namespace Model
} // namespace IAM
} // namespace Aws