Container for the parameters to the PutKeyPolicy operation. Attaches a key policy to the specified customer master key (CMK).

For more information about key policies, see Key Policies in the AWS Key Management Service Developer Guide.

Inheritance: AmazonKeyManagementServiceRequest
Example #1
0
        public object Execute(ExecutorContext context)
        {
            var cmdletContext = context as CmdletContext;
            // create request
            var request = new Amazon.KeyManagementService.Model.PutKeyPolicyRequest();

            if (cmdletContext.BypassPolicyLockoutSafetyCheck != null)
            {
                request.BypassPolicyLockoutSafetyCheck = cmdletContext.BypassPolicyLockoutSafetyCheck.Value;
            }
            if (cmdletContext.KeyId != null)
            {
                request.KeyId = cmdletContext.KeyId;
            }
            if (cmdletContext.Policy != null)
            {
                request.Policy = cmdletContext.Policy;
            }
            if (cmdletContext.PolicyName != null)
            {
                request.PolicyName = cmdletContext.PolicyName;
            }

            CmdletOutput output;

            // issue call
            var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint);

            try
            {
                var    response       = CallAWSServiceOperation(client, request);
                object pipelineOutput = null;
                pipelineOutput = cmdletContext.Select(response, this);
                output         = new CmdletOutput
                {
                    PipelineOutput  = pipelineOutput,
                    ServiceResponse = response
                };
            }
            catch (Exception e)
            {
                output = new CmdletOutput {
                    ErrorResponse = e
                };
            }

            return(output);
        }
        /// <summary>
        /// Initiates the asynchronous execution of the PutKeyPolicy operation.
        /// </summary>
        /// 
        /// <param name="request">Container for the necessary parameters to execute the PutKeyPolicy operation.</param>
        /// <param name="cancellationToken">
        ///     A cancellation token that can be used by other objects or threads to receive notice of cancellation.
        /// </param>
        /// <returns>The task object representing the asynchronous operation.</returns>
        public Task<PutKeyPolicyResponse> PutKeyPolicyAsync(PutKeyPolicyRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
        {
            var marshaller = new PutKeyPolicyRequestMarshaller();
            var unmarshaller = PutKeyPolicyResponseUnmarshaller.Instance;

            return InvokeAsync<PutKeyPolicyRequest,PutKeyPolicyResponse>(request, marshaller, 
                unmarshaller, cancellationToken);
        }
 /// <summary>
 /// Attaches a policy to the specified key.
 /// </summary>
 /// <param name="keyId">A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. <ul> <li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li> <li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li> </ul> </param>
 /// <param name="policy">The policy, in JSON format, to be attached to the key.</param>
 /// <param name="policyName">Name of the policy to be attached. Currently, the only supported name is "default".</param>
 /// <param name="cancellationToken">
 ///     A cancellation token that can be used by other objects or threads to receive notice of cancellation.
 /// </param>
 /// 
 /// <returns>The response from the PutKeyPolicy service method, as returned by KeyManagementService.</returns>
 /// <exception cref="Amazon.KeyManagementService.Model.DependencyTimeoutException">
 /// The system timed out while trying to fulfill the request.
 /// </exception>
 /// <exception cref="Amazon.KeyManagementService.Model.InvalidArnException">
 /// The request was rejected because a specified ARN was not valid.
 /// </exception>
 /// <exception cref="Amazon.KeyManagementService.Model.InvalidArnException">
 /// The request was rejected because a specified ARN was not valid.
 /// </exception>
 /// <exception cref="Amazon.KeyManagementService.Model.KMSInternalException">
 /// The request was rejected because an internal exception occurred. This error can be
 /// retried.
 /// </exception>
 /// <exception cref="Amazon.KeyManagementService.Model.LimitExceededException">
 /// The request was rejected because a quota was exceeded.
 /// </exception>
 /// <exception cref="Amazon.KeyManagementService.Model.MalformedPolicyDocumentException">
 /// The request was rejected because the specified policy is not syntactically or semantically
 /// correct.
 /// </exception>
 /// <exception cref="Amazon.KeyManagementService.Model.NotFoundException">
 /// The request was rejected because the specified entity or resource could not be found.
 /// </exception>
 /// <exception cref="Amazon.KeyManagementService.Model.UnsupportedOperationException">
 /// The request was rejected because a specified parameter is not supported.
 /// </exception>
 public Task<PutKeyPolicyResponse> PutKeyPolicyAsync(string keyId, string policy, string policyName, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
 {
     var request = new PutKeyPolicyRequest();
     request.KeyId = keyId;
     request.Policy = policy;
     request.PolicyName = policyName;
     return PutKeyPolicyAsync(request, cancellationToken);
 }
        /// <summary>
        /// Attaches a policy to the specified key.
        /// </summary>
        /// <param name="request">Container for the necessary parameters to execute the PutKeyPolicy service method.</param>
        /// 
        /// <returns>The response from the PutKeyPolicy service method, as returned by KeyManagementService.</returns>
        /// <exception cref="Amazon.KeyManagementService.Model.DependencyTimeoutException">
        /// The system timed out while trying to fulfill the request.
        /// </exception>
        /// <exception cref="Amazon.KeyManagementService.Model.InvalidArnException">
        /// The request was rejected because a specified ARN was not valid.
        /// </exception>
        /// <exception cref="Amazon.KeyManagementService.Model.InvalidArnException">
        /// The request was rejected because a specified ARN was not valid.
        /// </exception>
        /// <exception cref="Amazon.KeyManagementService.Model.KMSInternalException">
        /// The request was rejected because an internal exception occurred. This error can be
        /// retried.
        /// </exception>
        /// <exception cref="Amazon.KeyManagementService.Model.LimitExceededException">
        /// The request was rejected because a quota was exceeded.
        /// </exception>
        /// <exception cref="Amazon.KeyManagementService.Model.MalformedPolicyDocumentException">
        /// The request was rejected because the specified policy is not syntactically or semantically
        /// correct.
        /// </exception>
        /// <exception cref="Amazon.KeyManagementService.Model.NotFoundException">
        /// The request was rejected because the specified entity or resource could not be found.
        /// </exception>
        /// <exception cref="Amazon.KeyManagementService.Model.UnsupportedOperationException">
        /// The request was rejected because a specified parameter is not supported.
        /// </exception>
        public PutKeyPolicyResponse PutKeyPolicy(PutKeyPolicyRequest request)
        {
            var marshaller = new PutKeyPolicyRequestMarshaller();
            var unmarshaller = PutKeyPolicyResponseUnmarshaller.Instance;

            return Invoke<PutKeyPolicyRequest,PutKeyPolicyResponse>(request, marshaller, unmarshaller);
        }
 /// <summary>
 /// Attaches a policy to the specified key.
 /// </summary>
 /// <param name="keyId">A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. <ul> <li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li> <li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li> </ul> </param>
 /// <param name="policy">The policy, in JSON format, to be attached to the key.</param>
 /// <param name="policyName">Name of the policy to be attached. Currently, the only supported name is "default".</param>
 /// 
 /// <returns>The response from the PutKeyPolicy service method, as returned by KeyManagementService.</returns>
 /// <exception cref="Amazon.KeyManagementService.Model.DependencyTimeoutException">
 /// The system timed out while trying to fulfill the request.
 /// </exception>
 /// <exception cref="Amazon.KeyManagementService.Model.InvalidArnException">
 /// The request was rejected because a specified ARN was not valid.
 /// </exception>
 /// <exception cref="Amazon.KeyManagementService.Model.InvalidArnException">
 /// The request was rejected because a specified ARN was not valid.
 /// </exception>
 /// <exception cref="Amazon.KeyManagementService.Model.KMSInternalException">
 /// The request was rejected because an internal exception occurred. This error can be
 /// retried.
 /// </exception>
 /// <exception cref="Amazon.KeyManagementService.Model.LimitExceededException">
 /// The request was rejected because a quota was exceeded.
 /// </exception>
 /// <exception cref="Amazon.KeyManagementService.Model.MalformedPolicyDocumentException">
 /// The request was rejected because the specified policy is not syntactically or semantically
 /// correct.
 /// </exception>
 /// <exception cref="Amazon.KeyManagementService.Model.NotFoundException">
 /// The request was rejected because the specified entity or resource could not be found.
 /// </exception>
 /// <exception cref="Amazon.KeyManagementService.Model.UnsupportedOperationException">
 /// The request was rejected because a specified parameter is not supported.
 /// </exception>
 public PutKeyPolicyResponse PutKeyPolicy(string keyId, string policy, string policyName)
 {
     var request = new PutKeyPolicyRequest();
     request.KeyId = keyId;
     request.Policy = policy;
     request.PolicyName = policyName;
     return PutKeyPolicy(request);
 }
        /// <summary>
        /// Initiates the asynchronous execution of the PutKeyPolicy operation.
        /// </summary>
        /// 
        /// <param name="request">Container for the necessary parameters to execute the PutKeyPolicy operation on AmazonKeyManagementServiceClient.</param>
        /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param>
        /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
        ///          procedure using the AsyncState property.</param>
        /// 
        /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutKeyPolicy
        ///         operation.</returns>
        public IAsyncResult BeginPutKeyPolicy(PutKeyPolicyRequest request, AsyncCallback callback, object state)
        {
            var marshaller = new PutKeyPolicyRequestMarshaller();
            var unmarshaller = PutKeyPolicyResponseUnmarshaller.Instance;

            return BeginInvoke<PutKeyPolicyRequest>(request, marshaller, unmarshaller,
                callback, state);
        }
Example #7
0
 private Amazon.KeyManagementService.Model.PutKeyPolicyResponse CallAWSServiceOperation(IAmazonKeyManagementService client, Amazon.KeyManagementService.Model.PutKeyPolicyRequest request)
 {
     Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Key Management Service", "PutKeyPolicy");
     try
     {
         #if DESKTOP
         return(client.PutKeyPolicy(request));
         #elif CORECLR
         return(client.PutKeyPolicyAsync(request).GetAwaiter().GetResult());
         #else
                 #error "Unknown build edition"
         #endif
     }
     catch (AmazonServiceException exc)
     {
         var webException = exc.InnerException as System.Net.WebException;
         if (webException != null)
         {
             throw new Exception(Utils.Common.FormatNameResolutionFailureMessage(client.Config, webException.Message), webException);
         }
         throw;
     }
 }