Package software.amazon.smithy.aws.iam.traits

Class ConditionKeyDefinition

java.lang.Object

software.amazon.smithy.aws.iam.traits.ConditionKeyDefinition

All Implemented Interfaces:

ToNode, ToSmithyBuilder<ConditionKeyDefinition>

public final class ConditionKeyDefinition
extends java.lang.Object
implements ToNode, ToSmithyBuilder<ConditionKeyDefinition>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ConditionKeyDefinition.Builder

Method Summary

Modifier and Type	Method	Description
static ConditionKeyDefinition.Builder	builder()
boolean	equals(java.lang.Object o)
static ConditionKeyDefinition	fromNode(Node value)
java.util.Optional<java.lang.String>	getDocumentation()
java.util.Optional<java.lang.String>	getExternalDocumentation()
java.util.Optional<java.lang.String>	getRelativeDocumentation()	Get the relative URL path that defines more information about the condition key within a set of IAM-related documentation.
java.lang.String	getType()
int	hashCode()
boolean	isRequired()	Whether a service resolved condition key is required.
ConditionKeyDefinition.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
Node	toNode()	Converts a value to a Node.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static ConditionKeyDefinition.Builder builder()

fromNode

public static ConditionKeyDefinition fromNode(Node value)

getType

public java.lang.String getType()

Returns:

The IAM policy type of the value that will supplied for this condition key.

getDocumentation

public java.util.Optional<java.lang.String> getDocumentation()

Returns:

A short description of the role of the condition key.

getExternalDocumentation

public java.util.Optional<java.lang.String> getExternalDocumentation()

Returns:

A URL to the documentation page.

getRelativeDocumentation

public java.util.Optional<java.lang.String> getRelativeDocumentation()

Get the relative URL path that defines more information about the condition key within a set of IAM-related documentation.

Returns:

A relative URL to the documentation page.

isRequired

public boolean isRequired()

Whether a service resolved condition key is required. Not applicable to request resolved condition keys, as the native @required trait must be used.

Returns:

If the service resolved condition key is required.

toBuilder

public ConditionKeyDefinition.Builder toBuilder()

Description copied from interface: ToSmithyBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToSmithyBuilder<ConditionKeyDefinition>

Returns:

a builder for type T

toNode

public Node toNode()

Description copied from interface: ToNode

Converts a value to a Node.

Specified by:

toNode in interface ToNode

Returns:

Returns the creates Node.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object