/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include namespace Aws { namespace SecretsManager { namespace Model { /** */ class AWS_SECRETSMANAGER_API PutResourcePolicyRequest : public SecretsManagerRequest { public: PutResourcePolicyRequest(); // 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 "PutResourcePolicy"; } Aws::String SerializePayload() const override; Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

Specifies the secret that you want to attach the resource-based policy to. * You can specify either the ARN or the friendly name of the secret.

*

If you specify an ARN, we generally recommend that you specify a complete * ARN. You can specify a partial ARN too—for example, if you don’t include the * final hyphen and six random characters that Secrets Manager adds at the end of * the ARN when you created the secret. A partial ARN match can work as long as it * uniquely matches only one secret. However, if your secret has a name that ends * in a hyphen followed by six characters (before Secrets Manager adds the hyphen * and six characters to the ARN) and you try to use that as a partial ARN, then * those characters cause Secrets Manager to assume that you’re specifying a * complete ARN. This confusion can cause unexpected results. To avoid this * situation, we recommend that you don’t create secret names ending with a hyphen * followed by six characters.

If you specify an incomplete ARN without the * random suffix, and instead provide the 'friendly name', you must not * include the random suffix. If you do include the random suffix added by Secrets * Manager, you receive either a ResourceNotFoundException or an * AccessDeniedException error, depending on your permissions.

*/ inline const Aws::String& GetSecretId() const{ return m_secretId; } /** *

Specifies the secret that you want to attach the resource-based policy to. * You can specify either the ARN or the friendly name of the secret.

*

If you specify an ARN, we generally recommend that you specify a complete * ARN. You can specify a partial ARN too—for example, if you don’t include the * final hyphen and six random characters that Secrets Manager adds at the end of * the ARN when you created the secret. A partial ARN match can work as long as it * uniquely matches only one secret. However, if your secret has a name that ends * in a hyphen followed by six characters (before Secrets Manager adds the hyphen * and six characters to the ARN) and you try to use that as a partial ARN, then * those characters cause Secrets Manager to assume that you’re specifying a * complete ARN. This confusion can cause unexpected results. To avoid this * situation, we recommend that you don’t create secret names ending with a hyphen * followed by six characters.

If you specify an incomplete ARN without the * random suffix, and instead provide the 'friendly name', you must not * include the random suffix. If you do include the random suffix added by Secrets * Manager, you receive either a ResourceNotFoundException or an * AccessDeniedException error, depending on your permissions.

*/ inline bool SecretIdHasBeenSet() const { return m_secretIdHasBeenSet; } /** *

Specifies the secret that you want to attach the resource-based policy to. * You can specify either the ARN or the friendly name of the secret.

*

If you specify an ARN, we generally recommend that you specify a complete * ARN. You can specify a partial ARN too—for example, if you don’t include the * final hyphen and six random characters that Secrets Manager adds at the end of * the ARN when you created the secret. A partial ARN match can work as long as it * uniquely matches only one secret. However, if your secret has a name that ends * in a hyphen followed by six characters (before Secrets Manager adds the hyphen * and six characters to the ARN) and you try to use that as a partial ARN, then * those characters cause Secrets Manager to assume that you’re specifying a * complete ARN. This confusion can cause unexpected results. To avoid this * situation, we recommend that you don’t create secret names ending with a hyphen * followed by six characters.

If you specify an incomplete ARN without the * random suffix, and instead provide the 'friendly name', you must not * include the random suffix. If you do include the random suffix added by Secrets * Manager, you receive either a ResourceNotFoundException or an * AccessDeniedException error, depending on your permissions.

*/ inline void SetSecretId(const Aws::String& value) { m_secretIdHasBeenSet = true; m_secretId = value; } /** *

Specifies the secret that you want to attach the resource-based policy to. * You can specify either the ARN or the friendly name of the secret.

*

If you specify an ARN, we generally recommend that you specify a complete * ARN. You can specify a partial ARN too—for example, if you don’t include the * final hyphen and six random characters that Secrets Manager adds at the end of * the ARN when you created the secret. A partial ARN match can work as long as it * uniquely matches only one secret. However, if your secret has a name that ends * in a hyphen followed by six characters (before Secrets Manager adds the hyphen * and six characters to the ARN) and you try to use that as a partial ARN, then * those characters cause Secrets Manager to assume that you’re specifying a * complete ARN. This confusion can cause unexpected results. To avoid this * situation, we recommend that you don’t create secret names ending with a hyphen * followed by six characters.

If you specify an incomplete ARN without the * random suffix, and instead provide the 'friendly name', you must not * include the random suffix. If you do include the random suffix added by Secrets * Manager, you receive either a ResourceNotFoundException or an * AccessDeniedException error, depending on your permissions.

*/ inline void SetSecretId(Aws::String&& value) { m_secretIdHasBeenSet = true; m_secretId = std::move(value); } /** *

Specifies the secret that you want to attach the resource-based policy to. * You can specify either the ARN or the friendly name of the secret.

*

If you specify an ARN, we generally recommend that you specify a complete * ARN. You can specify a partial ARN too—for example, if you don’t include the * final hyphen and six random characters that Secrets Manager adds at the end of * the ARN when you created the secret. A partial ARN match can work as long as it * uniquely matches only one secret. However, if your secret has a name that ends * in a hyphen followed by six characters (before Secrets Manager adds the hyphen * and six characters to the ARN) and you try to use that as a partial ARN, then * those characters cause Secrets Manager to assume that you’re specifying a * complete ARN. This confusion can cause unexpected results. To avoid this * situation, we recommend that you don’t create secret names ending with a hyphen * followed by six characters.

If you specify an incomplete ARN without the * random suffix, and instead provide the 'friendly name', you must not * include the random suffix. If you do include the random suffix added by Secrets * Manager, you receive either a ResourceNotFoundException or an * AccessDeniedException error, depending on your permissions.

*/ inline void SetSecretId(const char* value) { m_secretIdHasBeenSet = true; m_secretId.assign(value); } /** *

Specifies the secret that you want to attach the resource-based policy to. * You can specify either the ARN or the friendly name of the secret.

*

If you specify an ARN, we generally recommend that you specify a complete * ARN. You can specify a partial ARN too—for example, if you don’t include the * final hyphen and six random characters that Secrets Manager adds at the end of * the ARN when you created the secret. A partial ARN match can work as long as it * uniquely matches only one secret. However, if your secret has a name that ends * in a hyphen followed by six characters (before Secrets Manager adds the hyphen * and six characters to the ARN) and you try to use that as a partial ARN, then * those characters cause Secrets Manager to assume that you’re specifying a * complete ARN. This confusion can cause unexpected results. To avoid this * situation, we recommend that you don’t create secret names ending with a hyphen * followed by six characters.

If you specify an incomplete ARN without the * random suffix, and instead provide the 'friendly name', you must not * include the random suffix. If you do include the random suffix added by Secrets * Manager, you receive either a ResourceNotFoundException or an * AccessDeniedException error, depending on your permissions.

*/ inline PutResourcePolicyRequest& WithSecretId(const Aws::String& value) { SetSecretId(value); return *this;} /** *

Specifies the secret that you want to attach the resource-based policy to. * You can specify either the ARN or the friendly name of the secret.

*

If you specify an ARN, we generally recommend that you specify a complete * ARN. You can specify a partial ARN too—for example, if you don’t include the * final hyphen and six random characters that Secrets Manager adds at the end of * the ARN when you created the secret. A partial ARN match can work as long as it * uniquely matches only one secret. However, if your secret has a name that ends * in a hyphen followed by six characters (before Secrets Manager adds the hyphen * and six characters to the ARN) and you try to use that as a partial ARN, then * those characters cause Secrets Manager to assume that you’re specifying a * complete ARN. This confusion can cause unexpected results. To avoid this * situation, we recommend that you don’t create secret names ending with a hyphen * followed by six characters.

If you specify an incomplete ARN without the * random suffix, and instead provide the 'friendly name', you must not * include the random suffix. If you do include the random suffix added by Secrets * Manager, you receive either a ResourceNotFoundException or an * AccessDeniedException error, depending on your permissions.

*/ inline PutResourcePolicyRequest& WithSecretId(Aws::String&& value) { SetSecretId(std::move(value)); return *this;} /** *

Specifies the secret that you want to attach the resource-based policy to. * You can specify either the ARN or the friendly name of the secret.

*

If you specify an ARN, we generally recommend that you specify a complete * ARN. You can specify a partial ARN too—for example, if you don’t include the * final hyphen and six random characters that Secrets Manager adds at the end of * the ARN when you created the secret. A partial ARN match can work as long as it * uniquely matches only one secret. However, if your secret has a name that ends * in a hyphen followed by six characters (before Secrets Manager adds the hyphen * and six characters to the ARN) and you try to use that as a partial ARN, then * those characters cause Secrets Manager to assume that you’re specifying a * complete ARN. This confusion can cause unexpected results. To avoid this * situation, we recommend that you don’t create secret names ending with a hyphen * followed by six characters.

If you specify an incomplete ARN without the * random suffix, and instead provide the 'friendly name', you must not * include the random suffix. If you do include the random suffix added by Secrets * Manager, you receive either a ResourceNotFoundException or an * AccessDeniedException error, depending on your permissions.

*/ inline PutResourcePolicyRequest& WithSecretId(const char* value) { SetSecretId(value); return *this;} /** *

A JSON-formatted string that's constructed according to the grammar and * syntax for an AWS resource-based policy. The policy in the string identifies who * can access or manage this secret and its versions. For information on how to * format a JSON parameter for the various command line tool environments, see Using * JSON for Parameters in the AWS CLI User Guide.

*/ inline const Aws::String& GetResourcePolicy() const{ return m_resourcePolicy; } /** *

A JSON-formatted string that's constructed according to the grammar and * syntax for an AWS resource-based policy. The policy in the string identifies who * can access or manage this secret and its versions. For information on how to * format a JSON parameter for the various command line tool environments, see Using * JSON for Parameters in the AWS CLI User Guide.

*/ inline bool ResourcePolicyHasBeenSet() const { return m_resourcePolicyHasBeenSet; } /** *

A JSON-formatted string that's constructed according to the grammar and * syntax for an AWS resource-based policy. The policy in the string identifies who * can access or manage this secret and its versions. For information on how to * format a JSON parameter for the various command line tool environments, see Using * JSON for Parameters in the AWS CLI User Guide.

*/ inline void SetResourcePolicy(const Aws::String& value) { m_resourcePolicyHasBeenSet = true; m_resourcePolicy = value; } /** *

A JSON-formatted string that's constructed according to the grammar and * syntax for an AWS resource-based policy. The policy in the string identifies who * can access or manage this secret and its versions. For information on how to * format a JSON parameter for the various command line tool environments, see Using * JSON for Parameters in the AWS CLI User Guide.

*/ inline void SetResourcePolicy(Aws::String&& value) { m_resourcePolicyHasBeenSet = true; m_resourcePolicy = std::move(value); } /** *

A JSON-formatted string that's constructed according to the grammar and * syntax for an AWS resource-based policy. The policy in the string identifies who * can access or manage this secret and its versions. For information on how to * format a JSON parameter for the various command line tool environments, see Using * JSON for Parameters in the AWS CLI User Guide.

*/ inline void SetResourcePolicy(const char* value) { m_resourcePolicyHasBeenSet = true; m_resourcePolicy.assign(value); } /** *

A JSON-formatted string that's constructed according to the grammar and * syntax for an AWS resource-based policy. The policy in the string identifies who * can access or manage this secret and its versions. For information on how to * format a JSON parameter for the various command line tool environments, see Using * JSON for Parameters in the AWS CLI User Guide.

*/ inline PutResourcePolicyRequest& WithResourcePolicy(const Aws::String& value) { SetResourcePolicy(value); return *this;} /** *

A JSON-formatted string that's constructed according to the grammar and * syntax for an AWS resource-based policy. The policy in the string identifies who * can access or manage this secret and its versions. For information on how to * format a JSON parameter for the various command line tool environments, see Using * JSON for Parameters in the AWS CLI User Guide.

*/ inline PutResourcePolicyRequest& WithResourcePolicy(Aws::String&& value) { SetResourcePolicy(std::move(value)); return *this;} /** *

A JSON-formatted string that's constructed according to the grammar and * syntax for an AWS resource-based policy. The policy in the string identifies who * can access or manage this secret and its versions. For information on how to * format a JSON parameter for the various command line tool environments, see Using * JSON for Parameters in the AWS CLI User Guide.

*/ inline PutResourcePolicyRequest& WithResourcePolicy(const char* value) { SetResourcePolicy(value); return *this;} /** *

Makes an optional API call to Zelkova to validate the Resource Policy to * prevent broad access to your secret.

*/ inline bool GetBlockPublicPolicy() const{ return m_blockPublicPolicy; } /** *

Makes an optional API call to Zelkova to validate the Resource Policy to * prevent broad access to your secret.

*/ inline bool BlockPublicPolicyHasBeenSet() const { return m_blockPublicPolicyHasBeenSet; } /** *

Makes an optional API call to Zelkova to validate the Resource Policy to * prevent broad access to your secret.

*/ inline void SetBlockPublicPolicy(bool value) { m_blockPublicPolicyHasBeenSet = true; m_blockPublicPolicy = value; } /** *

Makes an optional API call to Zelkova to validate the Resource Policy to * prevent broad access to your secret.

*/ inline PutResourcePolicyRequest& WithBlockPublicPolicy(bool value) { SetBlockPublicPolicy(value); return *this;} private: Aws::String m_secretId; bool m_secretIdHasBeenSet; Aws::String m_resourcePolicy; bool m_resourcePolicyHasBeenSet; bool m_blockPublicPolicy; bool m_blockPublicPolicyHasBeenSet; }; } // namespace Model } // namespace SecretsManager } // namespace Aws