libZSservicesZSamazonka-iamZSamazonka-iam
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.IAM.CreatePolicy

Description

Creates a new managed policy for your Amazon Web Services account.

This operation creates a policy version with a version identifier of v1 and sets v1 as the policy's default version. For more information about policy versions, see Versioning for managed policies in the IAM User Guide.

As a best practice, you can validate your IAM policies. To learn more, see Validating IAM policies in the IAM User Guide.

For more information about managed policies in general, see Managed policies and inline policies in the IAM User Guide.

Synopsis

Creating a Request

data CreatePolicy Source #

See: newCreatePolicy smart constructor.

Constructors

CreatePolicy' 

Fields

  • path :: Maybe Text

    The path for the policy.

    For more information about paths, see IAM identifiers in the IAM User Guide.

    This parameter is optional. If it is not included, it defaults to a slash (/).

    This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

    You cannot use an asterisk (*) in the path name.

  • description :: Maybe Text

    A friendly description of the policy.

    Typically used to store information about the permissions defined in the policy. For example, "Grants access to production DynamoDB tables."

    The policy description is immutable. After a value is assigned, it cannot be changed.

  • tags :: Maybe [Tag]

    A list of tags that you want to attach to the new IAM customer managed policy. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

    If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

  • policyName :: Text

    The friendly name of the policy.

    IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".

  • policyDocument :: Text

    The JSON policy document that you want to use as the content for the new policy.

    You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

    The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.

    To learn more about JSON policy grammar, see Grammar of the IAM JSON policy language in the IAM User Guide.

    The regex pattern used to validate this parameter is a string of characters consisting of the following:

    • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
    • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
    • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)

Instances

Instances details
Eq CreatePolicy Source # 
Instance details

Defined in Amazonka.IAM.CreatePolicy

Read CreatePolicy Source # 
Instance details

Defined in Amazonka.IAM.CreatePolicy

Show CreatePolicy Source # 
Instance details

Defined in Amazonka.IAM.CreatePolicy

Generic CreatePolicy Source # 
Instance details

Defined in Amazonka.IAM.CreatePolicy

Associated Types

type Rep CreatePolicy :: Type -> Type #

NFData CreatePolicy Source # 
Instance details

Defined in Amazonka.IAM.CreatePolicy

Methods

rnf :: CreatePolicy -> () #

Hashable CreatePolicy Source # 
Instance details

Defined in Amazonka.IAM.CreatePolicy

AWSRequest CreatePolicy Source # 
Instance details

Defined in Amazonka.IAM.CreatePolicy

Associated Types

type AWSResponse CreatePolicy #

ToHeaders CreatePolicy Source # 
Instance details

Defined in Amazonka.IAM.CreatePolicy

ToPath CreatePolicy Source # 
Instance details

Defined in Amazonka.IAM.CreatePolicy

ToQuery CreatePolicy Source # 
Instance details

Defined in Amazonka.IAM.CreatePolicy

type Rep CreatePolicy Source # 
Instance details

Defined in Amazonka.IAM.CreatePolicy

type Rep CreatePolicy = D1 ('MetaData "CreatePolicy" "Amazonka.IAM.CreatePolicy" "libZSservicesZSamazonka-iamZSamazonka-iam" 'False) (C1 ('MetaCons "CreatePolicy'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: (S1 ('MetaSel ('Just "policyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "policyDocument") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse CreatePolicy Source # 
Instance details

Defined in Amazonka.IAM.CreatePolicy

newCreatePolicy Source #

Create a value of CreatePolicy with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:path:CreatePolicy', createPolicy_path - The path for the policy.

For more information about paths, see IAM identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

You cannot use an asterisk (*) in the path name.

$sel:description:CreatePolicy', createPolicy_description - A friendly description of the policy.

Typically used to store information about the permissions defined in the policy. For example, "Grants access to production DynamoDB tables."

The policy description is immutable. After a value is assigned, it cannot be changed.

$sel:tags:CreatePolicy', createPolicy_tags - A list of tags that you want to attach to the new IAM customer managed policy. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

$sel:policyName:CreatePolicy', createPolicy_policyName - The friendly name of the policy.

IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".

$sel:policyDocument:CreatePolicy', createPolicy_policyDocument - The JSON policy document that you want to use as the content for the new policy.

You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.

To learn more about JSON policy grammar, see Grammar of the IAM JSON policy language in the IAM User Guide.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
  • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)

Request Lenses

createPolicy_path :: Lens' CreatePolicy (Maybe Text) Source #

The path for the policy.

For more information about paths, see IAM identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

You cannot use an asterisk (*) in the path name.

createPolicy_description :: Lens' CreatePolicy (Maybe Text) Source #

A friendly description of the policy.

Typically used to store information about the permissions defined in the policy. For example, "Grants access to production DynamoDB tables."

The policy description is immutable. After a value is assigned, it cannot be changed.

createPolicy_tags :: Lens' CreatePolicy (Maybe [Tag]) Source #

A list of tags that you want to attach to the new IAM customer managed policy. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

createPolicy_policyName :: Lens' CreatePolicy Text Source #

The friendly name of the policy.

IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".

createPolicy_policyDocument :: Lens' CreatePolicy Text Source #

The JSON policy document that you want to use as the content for the new policy.

You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.

To learn more about JSON policy grammar, see Grammar of the IAM JSON policy language in the IAM User Guide.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
  • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)

Destructuring the Response

data CreatePolicyResponse Source #

Contains the response to a successful CreatePolicy request.

See: newCreatePolicyResponse smart constructor.

Constructors

CreatePolicyResponse' 

Fields

Instances

Instances details
Eq CreatePolicyResponse Source # 
Instance details

Defined in Amazonka.IAM.CreatePolicy

Read CreatePolicyResponse Source # 
Instance details

Defined in Amazonka.IAM.CreatePolicy

Show CreatePolicyResponse Source # 
Instance details

Defined in Amazonka.IAM.CreatePolicy

Generic CreatePolicyResponse Source # 
Instance details

Defined in Amazonka.IAM.CreatePolicy

Associated Types

type Rep CreatePolicyResponse :: Type -> Type #

NFData CreatePolicyResponse Source # 
Instance details

Defined in Amazonka.IAM.CreatePolicy

Methods

rnf :: CreatePolicyResponse -> () #

type Rep CreatePolicyResponse Source # 
Instance details

Defined in Amazonka.IAM.CreatePolicy

type Rep CreatePolicyResponse = D1 ('MetaData "CreatePolicyResponse" "Amazonka.IAM.CreatePolicy" "libZSservicesZSamazonka-iamZSamazonka-iam" 'False) (C1 ('MetaCons "CreatePolicyResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "policy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Policy)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreatePolicyResponse Source #

Create a value of CreatePolicyResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:policy:CreatePolicyResponse', createPolicyResponse_policy - A structure containing details about the new policy.

$sel:httpStatus:CreatePolicyResponse', createPolicyResponse_httpStatus - The response's http status code.

Response Lenses

createPolicyResponse_policy :: Lens' CreatePolicyResponse (Maybe Policy) Source #

A structure containing details about the new policy.