Class Policy
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Policy.Builder,
Policy>
Contains information about a managed policy.
This data type is used as a response element in the CreatePolicy, GetPolicy, and ListPolicies operations.
For more information about managed policies, refer to Managed policies and inline policies in the IAM User Guide.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
Returns the value of the Arn property for this object.final Integer
The number of entities (users, groups, and roles) that the policy is attached to.static Policy.Builder
builder()
final Instant
The date and time, in ISO 8601 date-time format, when the policy was created.final String
The identifier for the version of the policy that is set as the default version.final String
A friendly description of the policy.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final Boolean
Specifies whether the policy can be attached to an IAM user, group, or role.final String
path()
The path to the policy.final Integer
The number of entities (users and roles) for which the policy is used to set the permissions boundary.final String
policyId()
The stable and unique string identifying the policy.final String
The friendly name (not ARN) identifying the policy.static Class
<? extends Policy.Builder> tags()
A list of tags that are attached to the instance profile.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Instant
The date and time, in ISO 8601 date-time format, when the policy was last updated.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
policyName
The friendly name (not ARN) identifying the policy.
- Returns:
- The friendly name (not ARN) identifying the policy.
-
policyId
The stable and unique string identifying the policy.
For more information about IDs, see IAM identifiers in the IAM User Guide.
- Returns:
- The stable and unique string identifying the policy.
For more information about IDs, see IAM identifiers in the IAM User Guide.
-
arn
Returns the value of the Arn property for this object.- Returns:
- The value of the Arn property for this object.
-
path
The path to the policy.
For more information about paths, see IAM identifiers in the IAM User Guide.
- Returns:
- The path to the policy.
For more information about paths, see IAM identifiers in the IAM User Guide.
-
defaultVersionId
The identifier for the version of the policy that is set as the default version.
- Returns:
- The identifier for the version of the policy that is set as the default version.
-
attachmentCount
The number of entities (users, groups, and roles) that the policy is attached to.
- Returns:
- The number of entities (users, groups, and roles) that the policy is attached to.
-
permissionsBoundaryUsageCount
The number of entities (users and roles) for which the policy is used to set the permissions boundary.
For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.
- Returns:
- The number of entities (users and roles) for which the policy is used to set the permissions boundary.
For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.
-
isAttachable
Specifies whether the policy can be attached to an IAM user, group, or role.
- Returns:
- Specifies whether the policy can be attached to an IAM user, group, or role.
-
description
A friendly description of the policy.
This element is included in the response to the GetPolicy operation. It is not included in the response to the ListPolicies operation.
- Returns:
- A friendly description of the policy.
This element is included in the response to the GetPolicy operation. It is not included in the response to the ListPolicies operation.
-
createDate
The date and time, in ISO 8601 date-time format, when the policy was created.
- Returns:
- The date and time, in ISO 8601 date-time format, when the policy was created.
-
updateDate
The date and time, in ISO 8601 date-time format, when the policy was last updated.
When a policy has only one version, this field contains the date and time when the policy was created. When a policy has more than one version, this field contains the date and time when the most recent policy version was created.
- Returns:
- The date and time, in ISO 8601 date-time format, when the
policy was last updated.
When a policy has only one version, this field contains the date and time when the policy was created. When a policy has more than one version, this field contains the date and time when the most recent policy version was created.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
tags
A list of tags that are attached to the instance profile. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()
method.- Returns:
- A list of tags that are attached to the instance profile. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<Policy.Builder,
Policy> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-