interface DeploymentPreferenceProperty

Language	Type name
.NET	Amazon.CDK.AWS.SAM.CfnFunction.DeploymentPreferenceProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awssam#CfnFunction_DeploymentPreferenceProperty
Java	software.amazon.awscdk.services.sam.CfnFunction.DeploymentPreferenceProperty
Python	aws_cdk.aws_sam.CfnFunction.DeploymentPreferenceProperty
TypeScript	aws-cdk-lib » aws_sam » CfnFunction » DeploymentPreferenceProperty

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-deploymentpreference.html

Example

// 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';
const deploymentPreferenceProperty: sam.CfnFunction.DeploymentPreferenceProperty = {
  alarms: ['alarms'],
  enabled: false,
  hooks: {
    postTraffic: 'postTraffic',
    preTraffic: 'preTraffic',
  },
  role: 'role',
  type: 'type',
};

Properties

Name	Type	Description
alarms?	string[]
enabled?	boolean | IResolvable
hooks?	IResolvable | HooksProperty
role?	string
type?	string

---

alarms?

Type: string[] (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-deploymentpreference.html#cfn-serverless-function-deploymentpreference-alarms

---

enabled?

Type: boolean | IResolvable (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-deploymentpreference.html#cfn-serverless-function-deploymentpreference-enabled

---

hooks?

Type: IResolvable | HooksProperty (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-deploymentpreference.html#cfn-serverless-function-deploymentpreference-hooks

---

role?

Type: string (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-deploymentpreference.html#cfn-serverless-function-deploymentpreference-role

---

type?

Type: string (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-deploymentpreference.html#cfn-serverless-function-deploymentpreference-type