Skip to content
v2.274.0

RegionalEndpointProperty Struct ​

Per-region endpoint information.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_lambda as lambda } from 'aws-cdk-lib';
const regionalEndpointProperty: lambda.CfnWebFunctionEndpoint.RegionalEndpointProperty = {
  authType: 'authType',
  domainName: 'domainName',
  revisionWeights: [{
    revisionId: 'revisionId',
    weight: 123,
  }],
  scalingConfig: {
    maxEnvironments: 123,
  },
  state: 'state',
  stateReason: 'stateReason',
  throttleConfig: {
    rateLimit: 123,
  },
  updateStatus: 'updateStatus',
  updateStatusReason: 'updateStatusReason',
};

Properties ​

authTypestringauth_typestrauthTypeStringAuthTypestringAuthType*string#
The authentication type for the endpoint.
domainNamestringdomain_namestrdomainNameStringDomainNamestringDomainName*string#
The domain name of the endpoint.
revisionWeightsIResolvable | IResolvable | CfnWebFunctionEndpoint.RevisionWeightProperty[]revision_weightstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, RevisionWeightProperty]]]revisionWeightsIResolvableRevisionWeightsIResolvableRevisionWeightsinterface{}#
The revision weights for the endpoint.
scalingConfigIResolvable | CfnWebFunctionEndpoint.ScalingConfigPropertyscaling_configtyping.Union[IResolvable, ScalingConfigProperty]scalingConfigIResolvableScalingConfigIResolvableScalingConfiginterface{}#
The scaling configuration for the endpoint.

Optionally constrains how many concurrent execution environments the endpoint can use, in addition to your account's vCPU quota.

statestringstatestrstateStringStatestringState*string#
The current state of the endpoint.
stateReasonstringstate_reasonstrstateReasonStringStateReasonstringStateReason*string#
The reason for the current state of the endpoint.
throttleConfigIResolvable | CfnWebFunctionEndpoint.ThrottleConfigPropertythrottle_configtyping.Union[IResolvable, ThrottleConfigProperty]throttleConfigIResolvableThrottleConfigIResolvableThrottleConfiginterface{}#
The throttling configuration for the endpoint.

Optionally constrains the request rate that the endpoint accepts, in addition to your account's rate limit quota.

updateStatusstringupdate_statusstrupdateStatusStringUpdateStatusstringUpdateStatus*string#
The status of the most recent update to the endpoint.
updateStatusReasonstringupdate_status_reasonstrupdateStatusReasonStringUpdateStatusReasonstringUpdateStatusReason*string#
The reason for the current update status of the endpoint.