You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iam/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,
}

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

Returns:

  • (String)


1008
1009
1010
1011
1012
1013
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 1008

class CreatePolicyVersionRequest < Struct.new(
  :policy_arn,
  :policy_document,
  :set_as_default)
  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.

The regex pattern used to validate this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (\u0020) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF). It also includes the special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D).

Returns:

  • (String)


1008
1009
1010
1011
1012
1013
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 1008

class CreatePolicyVersionRequest < Struct.new(
  :policy_arn,
  :policy_document,
  :set_as_default)
  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, 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.

Returns:

  • (Boolean)


1008
1009
1010
1011
1012
1013
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 1008

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