Package software.amazon.awssdk.services.config.model

Class PutConformancePackRequest

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.PutConformancePackRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutConformancePackRequest.Builder,PutConformancePackRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PutConformancePackRequest.Builder

Method Summary

Modifier and Type	Method	Description
static PutConformancePackRequest.Builder	builder()
List<ConformancePackInputParameter>	conformancePackInputParameters()	A list of ConformancePackInputParameter objects.
String	conformancePackName()	The unique name of the conformance pack you want to deploy.
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)
<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.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends PutConformancePackRequest.Builder>	serializableBuilderClass()
String	templateBody()	A string containing the full conformance pack template body.
String	templateS3Uri()	The location of the file containing the template body (s3://bucketname/prefix).
TemplateSSMDocumentDetails	templateSSMDocumentDetails()	An object of type TemplateSSMDocumentDetails, which contains the name or the Amazon Resource Name (ARN) of the Amazon Web Services Systems Manager document (SSM document) and the version of the SSM document that is used to create a conformance pack.
PutConformancePackRequest.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

conformancePackName

public final String conformancePackName()

The unique name of the conformance pack you want to deploy.

Returns:

The unique name of the conformance pack you want to deploy.

templateS3Uri

public final String templateS3Uri()

The location of the file containing the template body (s3://bucketname/prefix). The uri must point to a conformance pack template (max size: 300 KB) that is located in an Amazon S3 bucket in the same Region as the conformance pack.

You must have access to read Amazon S3 bucket. In addition, in order to ensure a successful deployment, the template object must not be in an archived storage class if this parameter is passed.

Returns:

The location of the file containing the template body (s3://bucketname/prefix). The uri must point to a conformance pack template (max size: 300 KB) that is located in an Amazon S3 bucket in the same Region as the conformance pack.

You must have access to read Amazon S3 bucket. In addition, in order to ensure a successful deployment, the template object must not be in an archived storage class if this parameter is passed.

templateBody

public final String templateBody()

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

You can use a YAML template with two resource types: Config rule (AWS::Config::ConfigRule) and remediation action (AWS::Config::RemediationConfiguration).

Returns:

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

You can use a YAML template with two resource types: Config rule (AWS::Config::ConfigRule) and remediation action (AWS::Config::RemediationConfiguration).

deliveryS3Bucket

public final String deliveryS3Bucket()

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

This field is optional.

Returns:

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

This field is optional.

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.

templateSSMDocumentDetails

public final TemplateSSMDocumentDetails templateSSMDocumentDetails()

An object of type TemplateSSMDocumentDetails, which contains the name or the Amazon Resource Name (ARN) of the Amazon Web Services Systems Manager document (SSM document) and the version of the SSM document that is used to create a conformance pack.

Returns:

An object of type TemplateSSMDocumentDetails, which contains the name or the Amazon Resource Name (ARN) of the Amazon Web Services Systems Manager document (SSM document) and the version of the SSM document that is used to create a conformance pack.

toBuilder

public PutConformancePackRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PutConformancePackRequest.Builder,PutConformancePackRequest>

Specified by:

toBuilder in class ConfigRequest

builder

public static PutConformancePackRequest.Builder builder()

serializableBuilderClass

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