Package software.amazon.awssdk.services.pcaconnectorad.model

Class Template

java.lang.Object

software.amazon.awssdk.services.pcaconnectorad.model.Template

All Implemented Interfaces:

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

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

An Active Directory compatible certificate template. Connectors issue certificates against these templates based on the requestor's Active Directory group membership.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Template.Builder

Method Summary

Modifier and Type	Method	Description
String	arn()	The Amazon Resource Name (ARN) that was returned when you called CreateTemplate.
static Template.Builder	builder()
String	connectorArn()	The Amazon Resource Name (ARN) that was returned when you called CreateConnector.
Instant	createdAt()	The date and time that the template was created.
TemplateDefinition	definition()	Template configuration to define the information included in certificates.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name()	Name of the templates.
String	objectIdentifier()	Object identifier of a template.
Integer	policySchema()	The template schema version.
TemplateRevision	revision()	The version of the template.
List<SdkField<?>>	sdkFields()
static Class<? extends Template.Builder>	serializableBuilderClass()
TemplateStatus	status()	Status of the template.
String	statusAsString()	Status of the template.
Template.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Instant	updatedAt()	The date and time that the template was updated.

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

arn

public final String arn()

The Amazon Resource Name (ARN) that was returned when you called CreateTemplate.

Returns:

The Amazon Resource Name (ARN) that was returned when you called CreateTemplate.

connectorArn

public final String connectorArn()

The Amazon Resource Name (ARN) that was returned when you called CreateConnector.

Returns:

The Amazon Resource Name (ARN) that was returned when you called CreateConnector.

createdAt

public final Instant createdAt()

The date and time that the template was created.

Returns:

The date and time that the template was created.

definition

public final TemplateDefinition definition()

Template configuration to define the information included in certificates. Define certificate validity and renewal periods, certificate request handling and enrollment options, key usage extensions, application policies, and cryptography settings.

Returns:

Template configuration to define the information included in certificates. Define certificate validity and renewal periods, certificate request handling and enrollment options, key usage extensions, application policies, and cryptography settings.

name

public final String name()

Name of the templates. Template names must be unique.

Returns:

Name of the templates. Template names must be unique.

objectIdentifier

public final String objectIdentifier()

Object identifier of a template.

Returns:

Object identifier of a template.

policySchema

public final Integer policySchema()

The template schema version. Template schema versions can be v2, v3, or v4. The template configuration options change based on the template schema version.

Returns:

The template schema version. Template schema versions can be v2, v3, or v4. The template configuration options change based on the template schema version.

revision

public final TemplateRevision revision()

The version of the template. Template updates will increment the minor revision. Re-enrolling all certificate holders will increment the major revision.

Returns:

The version of the template. Template updates will increment the minor revision. Re-enrolling all certificate holders will increment the major revision.

status

public final TemplateStatus status()

Status of the template. Status can be creating, active, deleting, or failed.

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

Returns:

Status of the template. Status can be creating, active, deleting, or failed.

See Also:

TemplateStatus

statusAsString

public final String statusAsString()

Status of the template. Status can be creating, active, deleting, or failed.

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

Returns:

Status of the template. Status can be creating, active, deleting, or failed.

See Also:

TemplateStatus

updatedAt

public final Instant updatedAt()

The date and time that the template was updated.

Returns:

The date and time that the template was updated.

toBuilder

public Template.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Template.Builder,Template>

builder

public static Template.Builder builder()

serializableBuilderClass

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

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo