software.amazon.awssdk.services.config.model

Class PutOrganizationConformancePackRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.config.model.ConfigRequest

software.amazon.awssdk.services.config.model.PutOrganizationConformancePackRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutOrganizationConformancePackRequest.Builder,PutOrganizationConformancePackRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PutOrganizationConformancePackRequest.Builder

Method Summary

Modifier and Type	Method and Description
static PutOrganizationConformancePackRequest.Builder	builder()
List<ConformancePackInputParameter>	conformancePackInputParameters() A list of ConformancePackInputParameter objects.
String	deliveryS3Bucket() The name of the Amazon S3 bucket where Config stores conformance pack templates.
String	deliveryS3KeyPrefix() The prefix for the Amazon S3 bucket.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<String>	excludedAccounts() A list of Amazon Web Services accounts to be excluded from an organization conformance pack while deploying a conformance pack.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasConformancePackInputParameters() For responses, this returns true if the service returned a value for the ConformancePackInputParameters property.
boolean	hasExcludedAccounts() For responses, this returns true if the service returned a value for the ExcludedAccounts property.
int	hashCode()
String	organizationConformancePackName() Name of the organization conformance pack you want to create.
List<SdkField<?>>	sdkFields()
static Class<? extends PutOrganizationConformancePackRequest.Builder>	serializableBuilderClass()
String	templateBody() A string containing full conformance pack template body.
String	templateS3Uri() Location of file containing the template body.
PutOrganizationConformancePackRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

organizationConformancePackName

public final String organizationConformancePackName()

Name of the organization conformance pack you want to create.

Returns:

Name of the organization conformance pack you want to create.

templateS3Uri

public final String templateS3Uri()

Location of file containing the template body. The uri must point to the conformance pack template (max size: 300 KB).

You must have access to read Amazon S3 bucket.

Returns:

Location of file containing the template body. The uri must point to the conformance pack template (max size: 300 KB).

You must have access to read Amazon S3 bucket.

templateBody

public final String templateBody()

A string containing full conformance pack template body. Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.

Returns:

A string containing full conformance pack template body. Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.

deliveryS3Bucket

public final String deliveryS3Bucket()

The name of the Amazon S3 bucket where Config stores conformance pack templates.

This field is optional. If used, it must be prefixed with awsconfigconforms.

Returns:

The name of the Amazon S3 bucket where Config stores conformance pack templates.

This field is optional. If used, it must be prefixed with awsconfigconforms.

deliveryS3KeyPrefix

public final String deliveryS3KeyPrefix()

The prefix for the Amazon S3 bucket.

This field is optional.

Returns:

The prefix for the Amazon S3 bucket.

This field is optional.

hasConformancePackInputParameters

public final boolean hasConformancePackInputParameters()

For responses, this returns true if the service returned a value for the ConformancePackInputParameters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

conformancePackInputParameters

public final List<ConformancePackInputParameter> conformancePackInputParameters()

A list of ConformancePackInputParameter objects.

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 hasConformancePackInputParameters() method.

Returns:

A list of ConformancePackInputParameter objects.

hasExcludedAccounts

public final boolean hasExcludedAccounts()

For responses, this returns true if the service returned a value for the ExcludedAccounts property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

excludedAccounts

public final List<String> excludedAccounts()

A list of Amazon Web Services accounts to be excluded from an organization conformance pack while deploying a conformance pack.

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 hasExcludedAccounts() method.

Returns:

A list of Amazon Web Services accounts to be excluded from an organization conformance pack while deploying a conformance pack.

toBuilder

public PutOrganizationConformancePackRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PutOrganizationConformancePackRequest.Builder,PutOrganizationConformancePackRequest>

Specified by:

toBuilder in class ConfigRequest

builder

public static PutOrganizationConformancePackRequest.Builder builder()

serializableBuilderClass

public static Class<? extends PutOrganizationConformancePackRequest.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