/* * Copyright 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. */ /* * Do not modify this file. This file is generated from the kms-2014-11-01.normal.json service model. */ using System; using System.Collections.Generic; using System.Xml.Serialization; using System.Text; using System.IO; using System.Net; using Amazon.Runtime; using Amazon.Runtime.Internal; namespace Amazon.KeyManagementService.Model { /// /// Container for the parameters to the UpdateAlias operation. /// Associates an existing KMS alias with a different KMS key. Each alias is associated /// with only one KMS key at a time, although a KMS key can have multiple aliases. The /// alias and the KMS key must be in the same Amazon Web Services account and Region. /// /// /// /// Adding, deleting, or updating an alias can allow or deny permission to the KMS key. /// For details, see ABAC /// for KMS in the Key Management Service Developer Guide. /// /// /// /// The current and new KMS key must be the same type (both symmetric or both asymmetric /// or both HMAC), and they must have the same key usage. This restriction prevents errors /// in code that uses aliases. If you must assign an alias to a different type of KMS /// key, use DeleteAlias to delete the old alias and CreateAlias to create /// a new alias. /// /// /// /// You cannot use UpdateAlias to change an alias name. To change an alias /// name, use DeleteAlias to delete the old alias and CreateAlias to create /// a new alias. /// /// /// /// Because an alias is not a property of a KMS key, you can create, update, and delete /// the aliases of a KMS key without affecting the KMS key. Also, aliases do not appear /// in the response from the DescribeKey operation. To get the aliases of all KMS /// keys in the account, use the ListAliases operation. /// /// /// /// The KMS key that you use for this operation must be in a compatible key state. For /// details, see Key /// states of KMS keys in the Key Management Service Developer Guide. /// /// /// /// Cross-account use: No. You cannot perform this operation on a KMS key in a /// different Amazon Web Services account. /// /// /// /// Required permissions /// /// /// /// For details, see Controlling /// access to aliases in the Key Management Service Developer Guide. /// /// /// /// Related operations: /// /// /// public partial class UpdateAliasRequest : AmazonKeyManagementServiceRequest { private string _aliasName; private string _targetKeyId; /// /// Gets and sets the property AliasName. /// /// Identifies the alias that is changing its KMS key. This value must begin with alias/ /// followed by the alias name, such as alias/ExampleAlias. You cannot use /// UpdateAlias to change the alias name. /// /// /// /// Do not include confidential or sensitive information in this field. This field may /// be displayed in plaintext in CloudTrail logs and other output. /// /// /// [AWSProperty(Required=true, Min=1, Max=256)] public string AliasName { get { return this._aliasName; } set { this._aliasName = value; } } // Check to see if AliasName property is set internal bool IsSetAliasName() { return this._aliasName != null; } /// /// Gets and sets the property TargetKeyId. /// /// Identifies the customer /// managed key to associate with the alias. You don't have permission to associate /// an alias with an Amazon /// Web Services managed key. /// /// /// /// The KMS key must be in the same Amazon Web Services account and Region as the alias. /// Also, the new target KMS key must be the same type as the current target KMS key (both /// symmetric or both asymmetric or both HMAC) and they must have the same key usage. /// /// /// /// /// Specify the key ID or key ARN of the KMS key. /// /// /// /// For example: /// /// /// /// To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. /// /// /// /// To verify that the alias is mapped to the correct KMS key, use ListAliases. /// /// [AWSProperty(Required=true, Min=1, Max=2048)] public string TargetKeyId { get { return this._targetKeyId; } set { this._targetKeyId = value; } } // Check to see if TargetKeyId property is set internal bool IsSetTargetKeyId() { return this._targetKeyId != null; } } }