class CfnComponentPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.ImageBuilder.Mixins.CfnComponentPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsimagebuilder/mixins#CfnComponentPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.imagebuilder.mixins.CfnComponentPropsMixin
Python	aws_cdk.mixins_preview.aws_imagebuilder.mixins.CfnComponentPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_imagebuilder » mixins » CfnComponentPropsMixin

Implements IMixin

Extends Mixin

Creates a new component that can be used to build, validate, test, and assess your image.

The component is based on a YAML document that you specify using exactly one of the following methods:

• Inline, using the data property in the request body.
• A URL that points to a YAML document file stored in Amazon S3, using the uri property in the request body.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as imagebuilder_mixins } from '@aws-cdk/mixins-preview/aws-imagebuilder';
const cfnComponentPropsMixin = new imagebuilder_mixins.CfnComponentPropsMixin({
  changeDescription: 'changeDescription',
  data: 'data',
  description: 'description',
  kmsKeyId: 'kmsKeyId',
  name: 'name',
  platform: 'platform',
  supportedOsVersions: ['supportedOsVersions'],
  tags: {
    tagsKey: 'tags',
  },
  uri: 'uri',
  version: 'version',
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnComponentPropsMixin(props: CfnComponentMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnComponentMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::ImageBuilder::Component.

Properties

Name	Type	Description
props	CfnComponentMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnComponentMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.