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,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#policy_arn ⇒ String

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) and AWS Service Namespaces] in the *AWS General Reference*.

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

Returns:

  • (String) 


1154
1155
1156
1157
1158
1159
 
# File 'lib/aws-sdk-iam/types.rb', line 1154

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

#policy_document ⇒ String

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 AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

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]: wikipedia.org/wiki/regex

Returns:

  • (String) 


1154
1155
1156
1157
1158
1159
 
# File 'lib/aws-sdk-iam/types.rb', line 1154

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

#set_as_default ⇒ Boolean

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) 


1154
1155
1156
1157
1158
1159
 
# File 'lib/aws-sdk-iam/types.rb', line 1154

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