interface DeploymentPreferenceProperty

Language	Type name
.NET	`Amazon.CDK.AWS.SAM.CfnFunction.DeploymentPreferenceProperty`
Java	`software.amazon.awscdk.services.sam.CfnFunction.DeploymentPreferenceProperty`
Python	`aws_cdk.aws_sam.CfnFunction.DeploymentPreferenceProperty`
TypeScript	`@aws-cdk/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 * as sam from '@aws-cdk/aws-sam';
const deploymentPreferenceProperty: sam.CfnFunction.DeploymentPreferenceProperty = {
  enabled: false,
  type: 'type',

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

Properties

Name	Type	Description
enabled	`boolean \|` `IResolvable`	`CfnFunction.DeploymentPreferenceProperty.Enabled`.
type	`string`	`CfnFunction.DeploymentPreferenceProperty.Type`.
alarms?	`string[]`	`CfnFunction.DeploymentPreferenceProperty.Alarms`.
hooks?	`IResolvable` `\|` `HooksProperty`	`CfnFunction.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.