Skip to content
v2.278.0

AuthProperty Struct ​

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sam as sam } from 'aws-cdk-lib';

declare const customStatements: any;
const authProperty: sam.CfnFunction.AuthProperty = {
  apiKeyRequired: false,
  authorizationScopes: ['authorizationScopes'],
  authorizer: 'authorizer',
  resourcePolicy: {
    awsAccountBlacklist: ['awsAccountBlacklist'],
    awsAccountWhitelist: ['awsAccountWhitelist'],
    customStatements: [customStatements],
    intrinsicVpcBlacklist: ['intrinsicVpcBlacklist'],
    intrinsicVpceBlacklist: ['intrinsicVpceBlacklist'],
    intrinsicVpceWhitelist: ['intrinsicVpceWhitelist'],
    intrinsicVpcWhitelist: ['intrinsicVpcWhitelist'],
    ipRangeBlacklist: ['ipRangeBlacklist'],
    ipRangeWhitelist: ['ipRangeWhitelist'],
    sourceVpcBlacklist: ['sourceVpcBlacklist'],
    sourceVpcWhitelist: ['sourceVpcWhitelist'],
  },
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

# custom_statements: Any

auth_property = sam.CfnFunction.AuthProperty(
    api_key_required=False,
    authorization_scopes=["authorizationScopes"],
    authorizer="authorizer",
    resource_policy=sam.CfnFunction.AuthResourcePolicyProperty(
        aws_account_blacklist=["awsAccountBlacklist"],
        aws_account_whitelist=["awsAccountWhitelist"],
        custom_statements=[custom_statements],
        intrinsic_vpc_blacklist=["intrinsicVpcBlacklist"],
        intrinsic_vpce_blacklist=["intrinsicVpceBlacklist"],
        intrinsic_vpce_whitelist=["intrinsicVpceWhitelist"],
        intrinsic_vpc_whitelist=["intrinsicVpcWhitelist"],
        ip_range_blacklist=["ipRangeBlacklist"],
        ip_range_whitelist=["ipRangeWhitelist"],
        source_vpc_blacklist=["sourceVpcBlacklist"],
        source_vpc_whitelist=["sourceVpcWhitelist"]
    )
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.SAM;

var customStatements;

var authProperty = new AuthProperty {
    ApiKeyRequired = false,
    AuthorizationScopes = new [] { "authorizationScopes" },
    Authorizer = "authorizer",
    ResourcePolicy = new AuthResourcePolicyProperty {
        AwsAccountBlacklist = new [] { "awsAccountBlacklist" },
        AwsAccountWhitelist = new [] { "awsAccountWhitelist" },
        CustomStatements = new [] { customStatements },
        IntrinsicVpcBlacklist = new [] { "intrinsicVpcBlacklist" },
        IntrinsicVpceBlacklist = new [] { "intrinsicVpceBlacklist" },
        IntrinsicVpceWhitelist = new [] { "intrinsicVpceWhitelist" },
        IntrinsicVpcWhitelist = new [] { "intrinsicVpcWhitelist" },
        IpRangeBlacklist = new [] { "ipRangeBlacklist" },
        IpRangeWhitelist = new [] { "ipRangeWhitelist" },
        SourceVpcBlacklist = new [] { "sourceVpcBlacklist" },
        SourceVpcWhitelist = new [] { "sourceVpcWhitelist" }
    }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var customStatements interface{}

authProperty := &AuthProperty{
	ApiKeyRequired: jsii.Boolean(false),
	AuthorizationScopes: []*string{
		jsii.String("authorizationScopes"),
	},
	Authorizer: jsii.String("authorizer"),
	ResourcePolicy: &AuthResourcePolicyProperty{
		AwsAccountBlacklist: []*string{
			jsii.String("awsAccountBlacklist"),
		},
		AwsAccountWhitelist: []*string{
			jsii.String("awsAccountWhitelist"),
		},
		CustomStatements: []interface{}{
			customStatements,
		},
		IntrinsicVpcBlacklist: []*string{
			jsii.String("intrinsicVpcBlacklist"),
		},
		IntrinsicVpceBlacklist: []*string{
			jsii.String("intrinsicVpceBlacklist"),
		},
		IntrinsicVpceWhitelist: []*string{
			jsii.String("intrinsicVpceWhitelist"),
		},
		IntrinsicVpcWhitelist: []*string{
			jsii.String("intrinsicVpcWhitelist"),
		},
		IpRangeBlacklist: []*string{
			jsii.String("ipRangeBlacklist"),
		},
		IpRangeWhitelist: []*string{
			jsii.String("ipRangeWhitelist"),
		},
		SourceVpcBlacklist: []*string{
			jsii.String("sourceVpcBlacklist"),
		},
		SourceVpcWhitelist: []*string{
			jsii.String("sourceVpcWhitelist"),
		},
	},
}

Properties ​

apiKeyRequiredoptionalboolean | IResolvableapi_key_requiredoptionaltyping.Union[bool, IResolvable]apiKeyRequiredoptionalBooleanApiKeyRequiredoptionalboolApiKeyRequiredoptionalinterface{} #
authorizationScopesoptionalstring[]authorization_scopesoptionaltyping.List[str]authorizationScopesoptionalList<String>AuthorizationScopesoptionalstring[]AuthorizationScopesoptional*[]*string #
authorizeroptionalstringauthorizeroptionalstrauthorizeroptionalStringAuthorizeroptionalstringAuthorizeroptional*string #
resourcePolicyoptionalIResolvable | CfnFunction.AuthResourcePolicyPropertyresource_policyoptionaltyping.Union[IResolvable, AuthResourcePolicyProperty]resourcePolicyoptionalIResolvableResourcePolicyoptionalIResolvableResourcePolicyoptionalinterface{} #