Package software.amazon.awscdk.services.iam

Enum Effect

java.lang.Object

java.lang.Enum<Effect>

software.amazon.awscdk.services.iam.Effect

All Implemented Interfaces:

Serializable, Comparable<Effect>, java.lang.constant.Constable

@Generated(value="jsii-pacmak/1.125.0 (build fdbe357)",
           date="2026-01-19T12:03:55.598Z")
@Stability(Stable)
public enum Effect
extends Enum<Effect>

The Effect element of an IAM policy.

Example:

 import software.amazon.awscdk.aws_apigatewayv2_authorizers.WebSocketIamAuthorizer;
 import software.amazon.awscdk.aws_apigatewayv2_integrations.WebSocketLambdaIntegration;
 // This function handles your connect route
 Function connectHandler;
 WebSocketApi webSocketApi = new WebSocketApi(this, "WebSocketApi");
 webSocketApi.addRoute("$connect", WebSocketRouteOptions.builder()
         .integration(new WebSocketLambdaIntegration("Integration", connectHandler))
         .authorizer(new WebSocketIamAuthorizer())
         .build());
 // Create an IAM user (identity)
 User user = new User(this, "User");
 String webSocketArn = Stack.of(this).formatArn(ArnComponents.builder()
         .service("execute-api")
         .resource(webSocketApi.getApiId())
         .build());
 // Grant access to the IAM user
 user.attachInlinePolicy(Policy.Builder.create(this, "AllowInvoke")
         .statements(List.of(
             PolicyStatement.Builder.create()
                     .actions(List.of("execute-api:Invoke"))
                     .effect(Effect.ALLOW)
                     .resources(List.of(webSocketArn))
                     .build()))
         .build());
 

See Also:

• https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_effect.html

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALLOW	Allows access to a resource in an IAM policy statement.
DENY	Explicitly deny access to a resource.

Method Summary

Modifier and Type	Method	Description
static Effect	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Effect[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ALLOW

@Stability(Stable)
public static final Effect ALLOW

Allows access to a resource in an IAM policy statement.

By default, access to resources are denied.

DENY

@Stability(Stable)
public static final Effect DENY

Explicitly deny access to a resource.

By default, all requests are denied implicitly.

See Also:

• https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html

Method Details

values

public static Effect[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Effect valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null