/* * Copyright 2010-2023 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. */ package com.amazonaws.services.iot.model; import java.io.Serializable; import com.amazonaws.AmazonWebServiceRequest; /** *
* Creates an IoT policy. *
** The created policy is the default version for the policy. This operation * creates a policy version with a version identifier of 1 and sets * 1 as the policy's default version. *
** Requires permission to access the CreatePolicy action. *
*/ public class CreatePolicyRequest extends AmazonWebServiceRequest implements Serializable { /** ** The policy name. *
*
* Constraints:
* Length: 1 - 128
* Pattern: [\w+=,.@-]+
*/
private String policyName;
/**
*
* The JSON document that describes the policy. policyDocument must * have a minimum length of 1, with a maximum length of 2048, excluding * whitespace. *
*
* Constraints:
* Length: 0 - 404600
* Pattern: [\s\S]*
*/
private String policyDocument;
/**
*
* Metadata which can be used to manage the policy. *
** For URI Request parameters use format: ...key1=value1&key2=value2... *
** For the CLI command-line parameter use format: &&tags * "key1=value1&key2=value2..." *
** For the cli-input-json file use format: "tags": * "key1=value1&key2=value2..." *
** The policy name. *
*
* Constraints:
* Length: 1 - 128
* Pattern: [\w+=,.@-]+
*
* @return
* The policy name. *
*/ public String getPolicyName() { return policyName; } /** ** The policy name. *
*
* Constraints:
* Length: 1 - 128
* Pattern: [\w+=,.@-]+
*
* @param policyName
* The policy name. *
*/ public void setPolicyName(String policyName) { this.policyName = policyName; } /** ** The policy name. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Length: 1 - 128
* Pattern: [\w+=,.@-]+
*
* @param policyName
* The policy name. *
* @return A reference to this updated object so that method calls can be * chained together. */ public CreatePolicyRequest withPolicyName(String policyName) { this.policyName = policyName; return this; } /** ** The JSON document that describes the policy. policyDocument must * have a minimum length of 1, with a maximum length of 2048, excluding * whitespace. *
*
* Constraints:
* Length: 0 - 404600
* Pattern: [\s\S]*
*
* @return
* The JSON document that describes the policy. * policyDocument must have a minimum length of 1, with a * maximum length of 2048, excluding whitespace. *
*/ public String getPolicyDocument() { return policyDocument; } /** ** The JSON document that describes the policy. policyDocument must * have a minimum length of 1, with a maximum length of 2048, excluding * whitespace. *
*
* Constraints:
* Length: 0 - 404600
* Pattern: [\s\S]*
*
* @param policyDocument
* The JSON document that describes the policy. * policyDocument must have a minimum length of 1, with a * maximum length of 2048, excluding whitespace. *
*/ public void setPolicyDocument(String policyDocument) { this.policyDocument = policyDocument; } /** ** The JSON document that describes the policy. policyDocument must * have a minimum length of 1, with a maximum length of 2048, excluding * whitespace. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Length: 0 - 404600
* Pattern: [\s\S]*
*
* @param policyDocument
* The JSON document that describes the policy. * policyDocument must have a minimum length of 1, with a * maximum length of 2048, excluding whitespace. *
* @return A reference to this updated object so that method calls can be * chained together. */ public CreatePolicyRequest withPolicyDocument(String policyDocument) { this.policyDocument = policyDocument; return this; } /** ** Metadata which can be used to manage the policy. *
** For URI Request parameters use format: ...key1=value1&key2=value2... *
** For the CLI command-line parameter use format: &&tags * "key1=value1&key2=value2..." *
** For the cli-input-json file use format: "tags": * "key1=value1&key2=value2..." *
** Metadata which can be used to manage the policy. *
** For URI Request parameters use format: * ...key1=value1&key2=value2... *
** For the CLI command-line parameter use format: &&tags * "key1=value1&key2=value2..." *
** For the cli-input-json file use format: "tags": * "key1=value1&key2=value2..." *
** Metadata which can be used to manage the policy. *
** For URI Request parameters use format: ...key1=value1&key2=value2... *
** For the CLI command-line parameter use format: &&tags * "key1=value1&key2=value2..." *
** For the cli-input-json file use format: "tags": * "key1=value1&key2=value2..." *
** Metadata which can be used to manage the policy. *
** For URI Request parameters use format: * ...key1=value1&key2=value2... *
** For the CLI command-line parameter use format: &&tags * "key1=value1&key2=value2..." *
** For the cli-input-json file use format: "tags": * "key1=value1&key2=value2..." *
** Metadata which can be used to manage the policy. *
** For URI Request parameters use format: ...key1=value1&key2=value2... *
** For the CLI command-line parameter use format: &&tags * "key1=value1&key2=value2..." *
** For the cli-input-json file use format: "tags": * "key1=value1&key2=value2..." *
** Returns a reference to this object so that method calls can be chained * together. * * @param tags
* Metadata which can be used to manage the policy. *
** For URI Request parameters use format: * ...key1=value1&key2=value2... *
** For the CLI command-line parameter use format: &&tags * "key1=value1&key2=value2..." *
** For the cli-input-json file use format: "tags": * "key1=value1&key2=value2..." *
** Metadata which can be used to manage the policy. *
** For URI Request parameters use format: ...key1=value1&key2=value2... *
** For the CLI command-line parameter use format: &&tags * "key1=value1&key2=value2..." *
** For the cli-input-json file use format: "tags": * "key1=value1&key2=value2..." *
** Returns a reference to this object so that method calls can be chained * together. * * @param tags
* Metadata which can be used to manage the policy. *
** For URI Request parameters use format: * ...key1=value1&key2=value2... *
** For the CLI command-line parameter use format: &&tags * "key1=value1&key2=value2..." *
** For the cli-input-json file use format: "tags": * "key1=value1&key2=value2..." *
*