aws-cdk-lib.aws_sam.CfnFunction.DeploymentPreferenceProperty

interface DeploymentPreferenceProperty

LanguageType name
.NETAmazon.CDK.AWS.SAM.CfnFunction.DeploymentPreferenceProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awssam#CfnFunction_DeploymentPreferenceProperty
Javasoftware.amazon.awscdk.services.sam.CfnFunction.DeploymentPreferenceProperty
Pythonaws_cdk.aws_sam.CfnFunction.DeploymentPreferenceProperty
TypeScript aws-cdk-lib » aws_sam » CfnFunction » DeploymentPreferenceProperty

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 = {
  enabled: false,
  type: 'type',

  // the properties below are optional
  alarms: ['alarms'],
  hooks: {
    postTraffic: 'postTraffic',
    preTraffic: 'preTraffic',
  },
};

Properties

NameTypeDescription
enabledboolean | IResolvableCfnFunction.DeploymentPreferenceProperty.Enabled.
typestringCfnFunction.DeploymentPreferenceProperty.Type.
alarms?string[]CfnFunction.DeploymentPreferenceProperty.Alarms.
hooks?IResolvable | HooksPropertyCfnFunction.DeploymentPreferenceProperty.Hooks.

enabled

Type: boolean | IResolvable

CfnFunction.DeploymentPreferenceProperty.Enabled.


type

Type: string

CfnFunction.DeploymentPreferenceProperty.Type.


alarms?

Type: string[] (optional)

CfnFunction.DeploymentPreferenceProperty.Alarms.


hooks?

Type: IResolvable | HooksProperty (optional)

CfnFunction.DeploymentPreferenceProperty.Hooks.