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

197 lines
8.8 KiB
C++

/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/cognito-identity/CognitoIdentity_EXPORTS.h>
#include <aws/cognito-identity/model/RoleMappingType.h>
#include <aws/cognito-identity/model/AmbiguousRoleResolutionType.h>
#include <aws/cognito-identity/model/RulesConfigurationType.h>
#include <utility>
namespace Aws
{
namespace Utils
{
namespace Json
{
class JsonValue;
class JsonView;
} // namespace Json
} // namespace Utils
namespace CognitoIdentity
{
namespace Model
{
/**
* <p>A role mapping.</p><p><h3>See Also:</h3> <a
* href="http://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/RoleMapping">AWS
* API Reference</a></p>
*/
class AWS_COGNITOIDENTITY_API RoleMapping
{
public:
RoleMapping();
RoleMapping(Aws::Utils::Json::JsonView jsonValue);
RoleMapping& operator=(Aws::Utils::Json::JsonView jsonValue);
Aws::Utils::Json::JsonValue Jsonize() const;
/**
* <p>The role mapping type. Token will use <code>cognito:roles</code> and
* <code>cognito:preferred_role</code> claims from the Cognito identity provider
* token to map groups to roles. Rules will attempt to match claims from the token
* to map to a role.</p>
*/
inline const RoleMappingType& GetType() const{ return m_type; }
/**
* <p>The role mapping type. Token will use <code>cognito:roles</code> and
* <code>cognito:preferred_role</code> claims from the Cognito identity provider
* token to map groups to roles. Rules will attempt to match claims from the token
* to map to a role.</p>
*/
inline bool TypeHasBeenSet() const { return m_typeHasBeenSet; }
/**
* <p>The role mapping type. Token will use <code>cognito:roles</code> and
* <code>cognito:preferred_role</code> claims from the Cognito identity provider
* token to map groups to roles. Rules will attempt to match claims from the token
* to map to a role.</p>
*/
inline void SetType(const RoleMappingType& value) { m_typeHasBeenSet = true; m_type = value; }
/**
* <p>The role mapping type. Token will use <code>cognito:roles</code> and
* <code>cognito:preferred_role</code> claims from the Cognito identity provider
* token to map groups to roles. Rules will attempt to match claims from the token
* to map to a role.</p>
*/
inline void SetType(RoleMappingType&& value) { m_typeHasBeenSet = true; m_type = std::move(value); }
/**
* <p>The role mapping type. Token will use <code>cognito:roles</code> and
* <code>cognito:preferred_role</code> claims from the Cognito identity provider
* token to map groups to roles. Rules will attempt to match claims from the token
* to map to a role.</p>
*/
inline RoleMapping& WithType(const RoleMappingType& value) { SetType(value); return *this;}
/**
* <p>The role mapping type. Token will use <code>cognito:roles</code> and
* <code>cognito:preferred_role</code> claims from the Cognito identity provider
* token to map groups to roles. Rules will attempt to match claims from the token
* to map to a role.</p>
*/
inline RoleMapping& WithType(RoleMappingType&& value) { SetType(std::move(value)); return *this;}
/**
* <p>If you specify Token or Rules as the <code>Type</code>,
* <code>AmbiguousRoleResolution</code> is required.</p> <p>Specifies the action to
* be taken if either no rules match the claim value for the <code>Rules</code>
* type, or there is no <code>cognito:preferred_role</code> claim and there are
* multiple <code>cognito:roles</code> matches for the <code>Token</code> type.</p>
*/
inline const AmbiguousRoleResolutionType& GetAmbiguousRoleResolution() const{ return m_ambiguousRoleResolution; }
/**
* <p>If you specify Token or Rules as the <code>Type</code>,
* <code>AmbiguousRoleResolution</code> is required.</p> <p>Specifies the action to
* be taken if either no rules match the claim value for the <code>Rules</code>
* type, or there is no <code>cognito:preferred_role</code> claim and there are
* multiple <code>cognito:roles</code> matches for the <code>Token</code> type.</p>
*/
inline bool AmbiguousRoleResolutionHasBeenSet() const { return m_ambiguousRoleResolutionHasBeenSet; }
/**
* <p>If you specify Token or Rules as the <code>Type</code>,
* <code>AmbiguousRoleResolution</code> is required.</p> <p>Specifies the action to
* be taken if either no rules match the claim value for the <code>Rules</code>
* type, or there is no <code>cognito:preferred_role</code> claim and there are
* multiple <code>cognito:roles</code> matches for the <code>Token</code> type.</p>
*/
inline void SetAmbiguousRoleResolution(const AmbiguousRoleResolutionType& value) { m_ambiguousRoleResolutionHasBeenSet = true; m_ambiguousRoleResolution = value; }
/**
* <p>If you specify Token or Rules as the <code>Type</code>,
* <code>AmbiguousRoleResolution</code> is required.</p> <p>Specifies the action to
* be taken if either no rules match the claim value for the <code>Rules</code>
* type, or there is no <code>cognito:preferred_role</code> claim and there are
* multiple <code>cognito:roles</code> matches for the <code>Token</code> type.</p>
*/
inline void SetAmbiguousRoleResolution(AmbiguousRoleResolutionType&& value) { m_ambiguousRoleResolutionHasBeenSet = true; m_ambiguousRoleResolution = std::move(value); }
/**
* <p>If you specify Token or Rules as the <code>Type</code>,
* <code>AmbiguousRoleResolution</code> is required.</p> <p>Specifies the action to
* be taken if either no rules match the claim value for the <code>Rules</code>
* type, or there is no <code>cognito:preferred_role</code> claim and there are
* multiple <code>cognito:roles</code> matches for the <code>Token</code> type.</p>
*/
inline RoleMapping& WithAmbiguousRoleResolution(const AmbiguousRoleResolutionType& value) { SetAmbiguousRoleResolution(value); return *this;}
/**
* <p>If you specify Token or Rules as the <code>Type</code>,
* <code>AmbiguousRoleResolution</code> is required.</p> <p>Specifies the action to
* be taken if either no rules match the claim value for the <code>Rules</code>
* type, or there is no <code>cognito:preferred_role</code> claim and there are
* multiple <code>cognito:roles</code> matches for the <code>Token</code> type.</p>
*/
inline RoleMapping& WithAmbiguousRoleResolution(AmbiguousRoleResolutionType&& value) { SetAmbiguousRoleResolution(std::move(value)); return *this;}
/**
* <p>The rules to be used for mapping users to roles.</p> <p>If you specify Rules
* as the role mapping type, <code>RulesConfiguration</code> is required.</p>
*/
inline const RulesConfigurationType& GetRulesConfiguration() const{ return m_rulesConfiguration; }
/**
* <p>The rules to be used for mapping users to roles.</p> <p>If you specify Rules
* as the role mapping type, <code>RulesConfiguration</code> is required.</p>
*/
inline bool RulesConfigurationHasBeenSet() const { return m_rulesConfigurationHasBeenSet; }
/**
* <p>The rules to be used for mapping users to roles.</p> <p>If you specify Rules
* as the role mapping type, <code>RulesConfiguration</code> is required.</p>
*/
inline void SetRulesConfiguration(const RulesConfigurationType& value) { m_rulesConfigurationHasBeenSet = true; m_rulesConfiguration = value; }
/**
* <p>The rules to be used for mapping users to roles.</p> <p>If you specify Rules
* as the role mapping type, <code>RulesConfiguration</code> is required.</p>
*/
inline void SetRulesConfiguration(RulesConfigurationType&& value) { m_rulesConfigurationHasBeenSet = true; m_rulesConfiguration = std::move(value); }
/**
* <p>The rules to be used for mapping users to roles.</p> <p>If you specify Rules
* as the role mapping type, <code>RulesConfiguration</code> is required.</p>
*/
inline RoleMapping& WithRulesConfiguration(const RulesConfigurationType& value) { SetRulesConfiguration(value); return *this;}
/**
* <p>The rules to be used for mapping users to roles.</p> <p>If you specify Rules
* as the role mapping type, <code>RulesConfiguration</code> is required.</p>
*/
inline RoleMapping& WithRulesConfiguration(RulesConfigurationType&& value) { SetRulesConfiguration(std::move(value)); return *this;}
private:
RoleMappingType m_type;
bool m_typeHasBeenSet;
AmbiguousRoleResolutionType m_ambiguousRoleResolution;
bool m_ambiguousRoleResolutionHasBeenSet;
RulesConfigurationType m_rulesConfiguration;
bool m_rulesConfigurationHasBeenSet;
};
} // namespace Model
} // namespace CognitoIdentity
} // namespace Aws