Package software.amazon.awssdk.services.accessanalyzer.model

Class ValidatePolicyRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.accessanalyzer.model.AccessAnalyzerRequest

software.amazon.awssdk.services.accessanalyzer.model.ValidatePolicyRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ValidatePolicyRequest.Builder,ValidatePolicyRequest>

@Generated("software.amazon.awssdk:codegen")
public final class ValidatePolicyRequest
extends AccessAnalyzerRequest
implements ToCopyableBuilder<ValidatePolicyRequest.Builder,ValidatePolicyRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ValidatePolicyRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ValidatePolicyRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Locale	locale()	The locale to use for localizing the findings.
String	localeAsString()	The locale to use for localizing the findings.
Integer	maxResults()	The maximum number of results to return in the response.
String	nextToken()	A token used for pagination of results returned.
String	policyDocument()	The JSON policy document to use as the content for the policy.
PolicyType	policyType()	The type of policy to validate.
String	policyTypeAsString()	The type of policy to validate.
List<SdkField<?>>	sdkFields()
static Class<? extends ValidatePolicyRequest.Builder>	serializableBuilderClass()
ValidatePolicyRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
ValidatePolicyResourceType	validatePolicyResourceType()	The type of resource to attach to your resource policy.
String	validatePolicyResourceTypeAsString()	The type of resource to attach to your resource policy.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

locale

public final Locale locale()

The locale to use for localizing the findings.

If the service returns an enum value that is not available in the current SDK version, locale will return Locale.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from localeAsString().

Returns:

The locale to use for localizing the findings.

See Also:

Locale

localeAsString

public final String localeAsString()

The locale to use for localizing the findings.

If the service returns an enum value that is not available in the current SDK version, locale will return Locale.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from localeAsString().

Returns:

The locale to use for localizing the findings.

See Also:

Locale

maxResults

public final Integer maxResults()

The maximum number of results to return in the response.

Returns:

The maximum number of results to return in the response.

nextToken

public final String nextToken()

A token used for pagination of results returned.

Returns:

A token used for pagination of results returned.

policyDocument

public final String policyDocument()

The JSON policy document to use as the content for the policy.

Returns:

The JSON policy document to use as the content for the policy.

policyType

public final PolicyType policyType()

The type of policy to validate. Identity policies grant permissions to IAM principals. Identity policies include managed and inline policies for IAM roles, users, and groups.

Resource policies grant permissions on Amazon Web Services resources. Resource policies include trust policies for IAM roles and bucket policies for Amazon S3 buckets. You can provide a generic input such as identity policy or resource policy or a specific input such as managed policy or Amazon S3 bucket policy.

Service control policies (SCPs) are a type of organization policy attached to an Amazon Web Services organization, organizational unit (OU), or an account.

If the service returns an enum value that is not available in the current SDK version, policyType will return PolicyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from policyTypeAsString().

Returns:

The type of policy to validate. Identity policies grant permissions to IAM principals. Identity policies include managed and inline policies for IAM roles, users, and groups.

Resource policies grant permissions on Amazon Web Services resources. Resource policies include trust policies for IAM roles and bucket policies for Amazon S3 buckets. You can provide a generic input such as identity policy or resource policy or a specific input such as managed policy or Amazon S3 bucket policy.

Service control policies (SCPs) are a type of organization policy attached to an Amazon Web Services organization, organizational unit (OU), or an account.

See Also:

PolicyType

policyTypeAsString

public final String policyTypeAsString()

The type of policy to validate. Identity policies grant permissions to IAM principals. Identity policies include managed and inline policies for IAM roles, users, and groups.

Resource policies grant permissions on Amazon Web Services resources. Resource policies include trust policies for IAM roles and bucket policies for Amazon S3 buckets. You can provide a generic input such as identity policy or resource policy or a specific input such as managed policy or Amazon S3 bucket policy.

Service control policies (SCPs) are a type of organization policy attached to an Amazon Web Services organization, organizational unit (OU), or an account.

If the service returns an enum value that is not available in the current SDK version, policyType will return PolicyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from policyTypeAsString().

Returns:

The type of policy to validate. Identity policies grant permissions to IAM principals. Identity policies include managed and inline policies for IAM roles, users, and groups.

Resource policies grant permissions on Amazon Web Services resources. Resource policies include trust policies for IAM roles and bucket policies for Amazon S3 buckets. You can provide a generic input such as identity policy or resource policy or a specific input such as managed policy or Amazon S3 bucket policy.

Service control policies (SCPs) are a type of organization policy attached to an Amazon Web Services organization, organizational unit (OU), or an account.

See Also:

PolicyType

validatePolicyResourceType

public final ValidatePolicyResourceType validatePolicyResourceType()

The type of resource to attach to your resource policy. Specify a value for the policy validation resource type only if the policy type is RESOURCE_POLICY. For example, to validate a resource policy to attach to an Amazon S3 bucket, you can choose AWS::S3::Bucket for the policy validation resource type.

For resource types not supported as valid values, IAM Access Analyzer runs policy checks that apply to all resource policies. For example, to validate a resource policy to attach to a KMS key, do not specify a value for the policy validation resource type and IAM Access Analyzer will run policy checks that apply to all resource policies.

If the service returns an enum value that is not available in the current SDK version, validatePolicyResourceType will return ValidatePolicyResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from validatePolicyResourceTypeAsString().

Returns:

The type of resource to attach to your resource policy. Specify a value for the policy validation resource type only if the policy type is RESOURCE_POLICY. For example, to validate a resource policy to attach to an Amazon S3 bucket, you can choose AWS::S3::Bucket for the policy validation resource type.

For resource types not supported as valid values, IAM Access Analyzer runs policy checks that apply to all resource policies. For example, to validate a resource policy to attach to a KMS key, do not specify a value for the policy validation resource type and IAM Access Analyzer will run policy checks that apply to all resource policies.

See Also:

ValidatePolicyResourceType

validatePolicyResourceTypeAsString

public final String validatePolicyResourceTypeAsString()

The type of resource to attach to your resource policy. Specify a value for the policy validation resource type only if the policy type is RESOURCE_POLICY. For example, to validate a resource policy to attach to an Amazon S3 bucket, you can choose AWS::S3::Bucket for the policy validation resource type.

For resource types not supported as valid values, IAM Access Analyzer runs policy checks that apply to all resource policies. For example, to validate a resource policy to attach to a KMS key, do not specify a value for the policy validation resource type and IAM Access Analyzer will run policy checks that apply to all resource policies.

If the service returns an enum value that is not available in the current SDK version, validatePolicyResourceType will return ValidatePolicyResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from validatePolicyResourceTypeAsString().

Returns:

The type of resource to attach to your resource policy. Specify a value for the policy validation resource type only if the policy type is RESOURCE_POLICY. For example, to validate a resource policy to attach to an Amazon S3 bucket, you can choose AWS::S3::Bucket for the policy validation resource type.

For resource types not supported as valid values, IAM Access Analyzer runs policy checks that apply to all resource policies. For example, to validate a resource policy to attach to a KMS key, do not specify a value for the policy validation resource type and IAM Access Analyzer will run policy checks that apply to all resource policies.

See Also:

ValidatePolicyResourceType

toBuilder

public ValidatePolicyRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ValidatePolicyRequest.Builder,ValidatePolicyRequest>

Specified by:

toBuilder in class AccessAnalyzerRequest

builder

public static ValidatePolicyRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ValidatePolicyRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String 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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo