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

Class ConditionKeysIndex

java.lang.Object

software.amazon.smithy.aws.iam.traits.ConditionKeysIndex

All Implemented Interfaces:

KnowledgeIndex

public final class ConditionKeysIndex
extends java.lang.Object
implements KnowledgeIndex

Provides an index of condition keys for a service, including any condition keys inferred from resource identifiers.

Constructor Summary

Constructors

Constructor	Description
ConditionKeysIndex(Model model)

Method Summary

Modifier and Type	Method	Description
java.util.Set<java.lang.String>	getConditionKeyNames(ToShapeId service)	Get all of the condition key names used in a service.
java.util.Set<java.lang.String>	getConditionKeyNames(ToShapeId service, ToShapeId resourceOrOperation)	Get all of the defined condition keys used in an operation or resource, including any inferred keys and keys inherited by parent resource bindings.
java.util.Map<java.lang.String,ConditionKeyDefinition>	getDefinedConditionKeys(ToShapeId service)	Get all of the explicit and inferred condition keys used in the entire service.
java.util.Map<java.lang.String,ConditionKeyDefinition>	getDefinedConditionKeys(ToShapeId service, ToShapeId resourceOrOperation)	Get all of the defined condition keys used in an operation or resource, including any inferred keys and keys inherited by parent resource bindings.
static ConditionKeysIndex	of(Model model)

Methods inherited from class java.lang.Object

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

Constructor Detail

ConditionKeysIndex

public ConditionKeysIndex(Model model)

Method Detail

of

public static ConditionKeysIndex of(Model model)

getDefinedConditionKeys

public java.util.Map<java.lang.String,ConditionKeyDefinition> getDefinedConditionKeys(ToShapeId service)

Get all of the explicit and inferred condition keys used in the entire service.

The result does not include global condition keys like "aws:accountId". Use getConditionKeyNames(software.amazon.smithy.model.shapes.ToShapeId) to find all of the condition keys used but not necessarily defined for a service.

Parameters:

service - Service shape/shapeId to get.

Returns:

Returns the conditions keys of the service or an empty map when not found.

getConditionKeyNames

public java.util.Set<java.lang.String> getConditionKeyNames(ToShapeId service)

Get all of the condition key names used in a service.

Parameters:

service - Service shape/shapeId use to scope the result.

Returns:

Returns the conditions keys of the service or an empty map when not found.

getConditionKeyNames

public java.util.Set<java.lang.String> getConditionKeyNames(ToShapeId service,
                                                            ToShapeId resourceOrOperation)

Get all of the defined condition keys used in an operation or resource, including any inferred keys and keys inherited by parent resource bindings.

Parameters:

service - Service shape/shapeId use to scope the result.

resourceOrOperation - Resource or operation shape/shapeId

Returns:

Returns the conditions keys of the service or an empty map when not found.

getDefinedConditionKeys

public java.util.Map<java.lang.String,ConditionKeyDefinition> getDefinedConditionKeys(ToShapeId service,
                                                                                            ToShapeId resourceOrOperation)

Get all of the defined condition keys used in an operation or resource, including any inferred keys and keys inherited by parent resource bindings.

The result does not include global condition keys like "aws:accountId". Use getConditionKeyNames(software.amazon.smithy.model.shapes.ToShapeId) to find all of the condition keys used but not necessarily defined for a resource or operation.

Parameters:

service - Service shape/shapeId use to scope the result.

resourceOrOperation - Resource or operation shape/shapeId

Returns:

Returns the conditions keys of the service or an empty map when not found.