CreatePolicyRequest (AWS Java SDK :: Services :: AWS Organizations 2.16.76 API)

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.organizations.model.OrganizationsRequest
    - - software.amazon.awssdk.services.organizations.model.CreatePolicyRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreatePolicyRequest.Builder,CreatePolicyRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreatePolicyRequest
extends OrganizationsRequest
implements ToCopyableBuilder<CreatePolicyRequest.Builder,CreatePolicyRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreatePolicyRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreatePolicyRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CreatePolicyRequest.Builder`	`builder()`
`String`	`content()` The policy text content to add to the new policy.
`String`	`description()` An optional description to assign to the policy.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`String`	`name()` The friendly name to assign to the policy.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreatePolicyRequest.Builder>`	`serializableBuilderClass()`
`List<Tag>`	`tags()` A list of tags that you want to attach to the newly created policy.
`CreatePolicyRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`PolicyType`	`type()` The type of policy to create.
`String`	`typeAsString()` The type of policy to create.

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
  - content
```
public final String content()
```
    The policy text content to add to the new policy. The text that you supply must adhere to the rules of the policy type you specify in the Type parameter.
    
    Returns:
    
    The policy text content to add to the new policy. The text that you supply must adhere to the rules of the policy type you specify in the Type parameter.
  - description
```
public final String description()
```
    An optional description to assign to the policy.
    
    Returns:
    
    An optional description to assign to the policy.
  - name
```
public final String name()
```
    The friendly name to assign to the policy.
    
    The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.
    
    Returns:
    
    The friendly name to assign to the policy.
    
    The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.
  - type
```
public final PolicyType type()
```
    The type of policy to create. You can specify one of the following values:
    If the service returns an enum value that is not available in the current SDK version, type will return PolicyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    Returns:
    The type of policy to create. You can specify one of the following values:
    
    AISERVICES_OPT_OUT_POLICY
    
    BACKUP_POLICY
    
    SERVICE_CONTROL_POLICY
    
    TAG_POLICY
    See Also:
    
    PolicyType
  - typeAsString
```
public final String typeAsString()
```
    The type of policy to create. You can specify one of the following values:
    If the service returns an enum value that is not available in the current SDK version, type will return PolicyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    Returns:
    The type of policy to create. You can specify one of the following values:
    
    AISERVICES_OPT_OUT_POLICY
    
    BACKUP_POLICY
    
    SERVICE_CONTROL_POLICY
    
    TAG_POLICY
    See Also:
    
    PolicyType
  - hasTags
```
public final boolean hasTags()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tags
```
public final List<Tag> tags()
```
    A list of tags that you want to attach to the newly created policy. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null. For more information about tagging, see Tagging AWS Organizations resources in the AWS Organizations User Guide.
    
    If any one of the tags is invalid or if you exceed the allowed number of tags for a policy, then the entire request fails and the policy is not created.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    A list of tags that you want to attach to the newly created policy. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null. For more information about tagging, see Tagging AWS Organizations resources in the AWS Organizations User Guide.
    
    If any one of the tags is invalid or if you exceed the allowed number of tags for a policy, then the entire request fails and the policy is not created.
  - toBuilder
```
public CreatePolicyRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreatePolicyRequest.Builder,CreatePolicyRequest>
    
    Specified by:
    
    toBuilder in class OrganizationsRequest
  - builder
```
public static CreatePolicyRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreatePolicyRequest.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

Class CreatePolicyRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

content

description

name

type

typeAsString

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields