Package software.amazon.awscdk.services.sam

Interface CfnFunction.AuthProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFunction.AuthProperty.Jsii$Proxy

Enclosing class:

CfnFunction

@Stability(Stable)
public static interface CfnFunction.AuthProperty
extends software.amazon.jsii.JsiiSerializable

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.sam.*;
 Object customStatements;
 AuthProperty authProperty = AuthProperty.builder()
         .apiKeyRequired(false)
         .authorizationScopes(List.of("authorizationScopes"))
         .authorizer("authorizer")
         .resourcePolicy(AuthResourcePolicyProperty.builder()
                 .awsAccountBlacklist(List.of("awsAccountBlacklist"))
                 .awsAccountWhitelist(List.of("awsAccountWhitelist"))
                 .customStatements(List.of(customStatements))
                 .intrinsicVpcBlacklist(List.of("intrinsicVpcBlacklist"))
                 .intrinsicVpceBlacklist(List.of("intrinsicVpceBlacklist"))
                 .intrinsicVpceWhitelist(List.of("intrinsicVpceWhitelist"))
                 .intrinsicVpcWhitelist(List.of("intrinsicVpcWhitelist"))
                 .ipRangeBlacklist(List.of("ipRangeBlacklist"))
                 .ipRangeWhitelist(List.of("ipRangeWhitelist"))
                 .sourceVpcBlacklist(List.of("sourceVpcBlacklist"))
                 .sourceVpcWhitelist(List.of("sourceVpcWhitelist"))
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnFunction.AuthProperty.Builder	A builder for CfnFunction.AuthProperty
static final class	CfnFunction.AuthProperty.Jsii$Proxy	An implementation for CfnFunction.AuthProperty

Method Summary

Modifier and Type	Method	Description
static CfnFunction.AuthProperty.Builder	builder()
default Object	getApiKeyRequired()	CfnFunction.AuthProperty.ApiKeyRequired.
default List<String>	getAuthorizationScopes()	CfnFunction.AuthProperty.AuthorizationScopes.
default String	getAuthorizer()	CfnFunction.AuthProperty.Authorizer.
default Object	getResourcePolicy()	CfnFunction.AuthProperty.ResourcePolicy.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApiKeyRequired

@Stability(Stable)
@Nullable
default Object getApiKeyRequired()

CfnFunction.AuthProperty.ApiKeyRequired.

getAuthorizationScopes

@Stability(Stable)
@Nullable
default List<String> getAuthorizationScopes()

CfnFunction.AuthProperty.AuthorizationScopes.

getAuthorizer

@Stability(Stable)
@Nullable
default String getAuthorizer()

CfnFunction.AuthProperty.Authorizer.

getResourcePolicy

@Stability(Stable)
@Nullable
default Object getResourcePolicy()

CfnFunction.AuthProperty.ResourcePolicy.

builder

@Stability(Stable)
static CfnFunction.AuthProperty.Builder builder()

Returns:

a CfnFunction.AuthProperty.Builder of CfnFunction.AuthProperty