Class: Aws::IAM::Types::CreatePolicyVersionRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-iam/types.rb

Overview

Note:

When making an API call, you may pass CreatePolicyVersionRequest data as a hash:

{
  policy_arn: "arnType", # required
  policy_document: "policyDocumentType", # required
  set_as_default: false,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#policy_arnString

The Amazon Resource Name (ARN) of the IAM policy to which you want to add a new version.

For more information about ARNs, see [Amazon Resource Names (ARNs)] in the *Amazon Web Services General Reference*.

[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

Returns:

  • (String)

1295
1296
1297
1298
1299
1300
1301
# File 'lib/aws-sdk-iam/types.rb', line 1295

class CreatePolicyVersionRequest < Struct.new(
  :policy_arn,
  :policy_document,
  :set_as_default)
  SENSITIVE = []
  include Aws::Structure
end

#policy_documentString

The JSON policy document that you want to use as the content for this new version of the 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].

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`)

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length [2]: wikipedia.org/wiki/regex

Returns:

  • (String)

1295
1296
1297
1298
1299
1300
1301
# File 'lib/aws-sdk-iam/types.rb', line 1295

class CreatePolicyVersionRequest < Struct.new(
  :policy_arn,
  :policy_document,
  :set_as_default)
  SENSITIVE = []
  include Aws::Structure
end

#set_as_defaultBoolean

Specifies whether to set this version as the policy's default version.

When this parameter is `true`, the new policy version becomes the operative version. That is, it becomes the version that is in effect for the IAM users, groups, and roles that the policy is attached to.

For more information about managed policy versions, see [Versioning for managed policies] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html

Returns:

  • (Boolean)

1295
1296
1297
1298
1299
1300
1301
# File 'lib/aws-sdk-iam/types.rb', line 1295

class CreatePolicyVersionRequest < Struct.new(
  :policy_arn,
  :policy_document,
  :set_as_default)
  SENSITIVE = []
  include Aws::Structure
end