Class CertificateOptions

java.lang.Object

software.amazon.awssdk.services.acm.model.CertificateOptions

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CertificateOptions.Builder,CertificateOptions>

@Generated("software.amazon.awssdk:codegen")
public final class CertificateOptions
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CertificateOptions.Builder,CertificateOptions>

Structure that contains options for your certificate. You can use this structure to specify whether to opt in to or out of certificate transparency logging and export your certificate.

Some browsers require that public certificates issued for your domain be recorded in a log. Certificates that are not logged typically generate a browser error. Transparency makes it possible for you to detect SSL/TLS certificates that have been mistakenly or maliciously issued for your domain. For general information, see Certificate Transparency Logging.

You can export public ACM certificates to use with Amazon Web Services services as well as outside Amazon Web Services Cloud. For more information, see Certificate Manager exportable public certificate.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CertificateOptions.Builder

Method Summary

Modifier and Type	Method	Description
static CertificateOptions.Builder	builder()
final CertificateTransparencyLoggingPreference	certificateTransparencyLoggingPreference()	You can opt out of certificate transparency logging by specifying the DISABLED option.
final String	certificateTransparencyLoggingPreferenceAsString()	You can opt out of certificate transparency logging by specifying the DISABLED option.
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final CertificateExport	export()	You can opt in to allow the export of your certificates by specifying ENABLED.
final String	exportAsString()	You can opt in to allow the export of your certificates by specifying ENABLED.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends CertificateOptions.Builder>	serializableBuilderClass()
CertificateOptions.Builder	toBuilder()	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.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Details

certificateTransparencyLoggingPreference

public final CertificateTransparencyLoggingPreference certificateTransparencyLoggingPreference()

You can opt out of certificate transparency logging by specifying the DISABLED option. Opt in by specifying ENABLED.

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

Returns:

You can opt out of certificate transparency logging by specifying the DISABLED option. Opt in by specifying ENABLED.

See Also:

• CertificateTransparencyLoggingPreference

certificateTransparencyLoggingPreferenceAsString

public final String certificateTransparencyLoggingPreferenceAsString()

You can opt out of certificate transparency logging by specifying the DISABLED option. Opt in by specifying ENABLED.

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

Returns:

You can opt out of certificate transparency logging by specifying the DISABLED option. Opt in by specifying ENABLED.

See Also:

• CertificateTransparencyLoggingPreference

export

public final CertificateExport export()

You can opt in to allow the export of your certificates by specifying ENABLED.

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

Returns:

You can opt in to allow the export of your certificates by specifying ENABLED.

See Also:

• CertificateExport

exportAsString

public final String exportAsString()

You can opt in to allow the export of your certificates by specifying ENABLED.

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

Returns:

You can opt in to allow the export of your certificates by specifying ENABLED.

See Also:

• CertificateExport

toBuilder

public CertificateOptions.Builder 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 interface ToCopyableBuilder<CertificateOptions.Builder,CertificateOptions>

Returns:

a builder for type T

builder

public static CertificateOptions.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

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 an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo

Returns:

The mapping between the field name and its corresponding field.