Interface ICfnInfrastructureConfigurationProps
Properties for defining a CfnInfrastructureConfiguration.
Namespace: Amazon.CDK.AWS.ImageBuilder
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnInfrastructureConfigurationPropsSyntax (vb)
Public Interface ICfnInfrastructureConfigurationPropsRemarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ImageBuilder;
var cfnInfrastructureConfigurationProps = new CfnInfrastructureConfigurationProps {
InstanceProfileName = "instanceProfileName",
Name = "name",
// the properties below are optional
Description = "description",
InstanceMetadataOptions = new InstanceMetadataOptionsProperty {
HttpPutResponseHopLimit = 123,
HttpTokens = "httpTokens"
},
InstanceTypes = new [] { "instanceTypes" },
KeyPair = "keyPair",
Logging = new LoggingProperty {
S3Logs = new S3LogsProperty {
S3BucketName = "s3BucketName",
S3KeyPrefix = "s3KeyPrefix"
}
},
Placement = new PlacementProperty {
AvailabilityZone = "availabilityZone",
HostId = "hostId",
HostResourceGroupArn = "hostResourceGroupArn",
Tenancy = "tenancy"
},
ResourceTags = new Dictionary<string, string> {
{ "resourceTagsKey", "resourceTags" }
},
SecurityGroupIds = new [] { "securityGroupIds" },
SnsTopicArn = "snsTopicArn",
SubnetId = "subnetId",
Tags = new Dictionary<string, string> {
{ "tagsKey", "tags" }
},
TerminateInstanceOnFailure = false
};Synopsis
Properties
| Description | The description of the infrastructure configuration. |
| Instance |
The instance metadata options that you can set for the HTTP requests that pipeline builds use to launch EC2 build and test instances. |
| Instance |
The instance profile to associate with the instance used to customize your Amazon EC2 AMI. |
| Instance |
The instance types of the infrastructure configuration. |
| Key |
The key pair of the infrastructure configuration. |
| Logging | The logging configuration of the infrastructure configuration. |
| Name | The name of the infrastructure configuration. |
| Placement | The instance placement settings that define where the instances that are launched from your image will run. |
| Resource |
The metadata tags to assign to the Amazon EC2 instance that Image Builder launches during the build process. |
| Security |
The security group IDs to associate with the instance used to customize your Amazon EC2 AMI. |
| Sns |
The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications. |
| Subnet |
The subnet ID in which to place the instance used to customize your Amazon EC2 AMI. |
| Tags | The metadata tags to assign to the infrastructure configuration resource that Image Builder creates as output. |
| Terminate |
The terminate instance on failure setting of the infrastructure configuration. |
Properties
Description
The description of the infrastructure configuration.
virtual string Description { get; }Property Value
System.
Remarks
InstanceMetadataOptions
The instance metadata options that you can set for the HTTP requests that pipeline builds use to launch EC2 build and test instances.
virtual object InstanceMetadataOptions { get; }Property Value
System.
Remarks
InstanceProfileName
The instance profile to associate with the instance used to customize your Amazon EC2 AMI.
string InstanceProfileName { get; }Property Value
System.
Remarks
InstanceTypes
The instance types of the infrastructure configuration.
virtual string[] InstanceTypes { get; }Property Value
System.
Remarks
You can specify one or more instance types to use for this build. The service will pick one of these instance types based on availability.
KeyPair
The key pair of the infrastructure configuration.
virtual string KeyPair { get; }Property Value
System.
Remarks
You can use this to log on to and debug the instance used to create your image.
Logging
The logging configuration of the infrastructure configuration.
virtual object Logging { get; }Property Value
System.
Remarks
Name
The name of the infrastructure configuration.
string Name { get; }Property Value
System.
Remarks
Placement
The instance placement settings that define where the instances that are launched from your image will run.
virtual object Placement { get; }Property Value
System.
Remarks
ResourceTags
The metadata tags to assign to the Amazon EC2 instance that Image Builder launches during the build process.
virtual object ResourceTags { get; }Property Value
System.
Remarks
SecurityGroupIds
The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.
virtual string[] SecurityGroupIds { get; }Property Value
System.
Remarks
SnsTopicArn
The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications.
virtual string SnsTopicArn { get; }Property Value
System.
Remarks
EC2 Image Builder is unable to send notifications to SNS topics that are encrypted using keys from other accounts. The key that is used to encrypt the SNS topic must reside in the account that the Image Builder service runs under.
SubnetId
The subnet ID in which to place the instance used to customize your Amazon EC2 AMI.
virtual string SubnetId { get; }Property Value
System.
Remarks
Tags
The metadata tags to assign to the infrastructure configuration resource that Image Builder creates as output.
virtual IDictionary<string, string> Tags { get; }Property Value
System.
Remarks
Tags are formatted as key value pairs.
TerminateInstanceOnFailure
The terminate instance on failure setting of the infrastructure configuration.
virtual object TerminateInstanceOnFailure { get; }Property Value
System.
Remarks
Set to false if you want Image Builder to retain the instance used to configure your AMI if the build or test phase of your workflow fails.