Class CfnInfrastructureConfiguration
A CloudFormation AWS::ImageBuilder::InfrastructureConfiguration
.
Inheritance
Inherited Members
Namespace: Amazon.CDK.AWS.ImageBuilder
Assembly: Amazon.CDK.AWS.ImageBuilder.dll
Syntax (csharp)
public class CfnInfrastructureConfiguration : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnInfrastructureConfiguration
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The infrastructure configuration allows you to specify the infrastructure within which to build and test your image. In the infrastructure configuration, you can specify instance types, subnets, and security groups to associate with your instance. You can also associate an Amazon EC2 key pair with the instance used to build your image. This allows you to log on to your instance to troubleshoot if your build fails and you set terminateInstanceOnFailure to false.
CloudformationResource: AWS::ImageBuilder::InfrastructureConfiguration
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 cfnInfrastructureConfiguration = new CfnInfrastructureConfiguration(this, "MyCfnInfrastructureConfiguration", 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"
}
},
ResourceTags = new Dictionary<string, string> {
{ "resourceTagsKey", "resourceTags" }
},
SecurityGroupIds = new [] { "securityGroupIds" },
SnsTopicArn = "snsTopicArn",
SubnetId = "subnetId",
Tags = new Dictionary<string, string> {
{ "tagsKey", "tags" }
},
TerminateInstanceOnFailure = false
});
Synopsis
Constructors
CfnInfrastructureConfiguration(Construct, String, ICfnInfrastructureConfigurationProps) | Create a new |
CfnInfrastructureConfiguration(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnInfrastructureConfiguration(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrArn | Returns the Amazon Resource Name (ARN) of the infrastructure configuration. |
AttrName | The name of the infrastructure configuration. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | The description of the infrastructure configuration. |
InstanceMetadataOptions | The instance metadata option settings for the infrastructure configuration. |
InstanceProfileName | The instance profile of the infrastructure configuration. |
InstanceTypes | The instance types of the infrastructure configuration. |
KeyPair | The Amazon EC2 key pair of the infrastructure configuration. |
Logging | The logging configuration defines where Image Builder uploads your logs. |
Name | The name of the infrastructure configuration. |
ResourceTags | The tags attached to the resource created by Image Builder. |
SecurityGroupIds | The security group IDs of the infrastructure configuration. |
SnsTopicArn | The Amazon Resource Name (ARN) of the SNS topic for the infrastructure configuration. |
SubnetId | The subnet ID of the infrastructure configuration. |
Tags | The tags of the infrastructure configuration. |
TerminateInstanceOnFailure | The terminate instance on failure configuration of the infrastructure configuration. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnInfrastructureConfiguration(Construct, String, ICfnInfrastructureConfigurationProps)
Create a new AWS::ImageBuilder::InfrastructureConfiguration
.
public CfnInfrastructureConfiguration(Construct scope, string id, ICfnInfrastructureConfigurationProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnInfrastructureConfigurationProps
- resource properties.
CfnInfrastructureConfiguration(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnInfrastructureConfiguration(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnInfrastructureConfiguration(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnInfrastructureConfiguration(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
Returns the Amazon Resource Name (ARN) of the infrastructure configuration.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
The following pattern is applied: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:\d{12}|aws):(?:image-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline)/[a-z0-9-_]+(?:/(?:(?:x|\d+).(?:x|\d+).(?:x|\d+))(?:/\d+)?)?$
.
CloudformationAttribute: Arn
AttrName
The name of the infrastructure configuration.
public virtual string AttrName { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Name
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Description
The description of the infrastructure configuration.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
InstanceMetadataOptions
The instance metadata option settings for the infrastructure configuration.
public virtual object InstanceMetadataOptions { get; set; }
Property Value
System.Object
Remarks
InstanceProfileName
The instance profile of the infrastructure configuration.
public virtual string InstanceProfileName { get; set; }
Property Value
System.String
Remarks
InstanceTypes
The instance types of the infrastructure configuration.
public virtual string[] InstanceTypes { get; set; }
Property Value
System.String[]
Remarks
KeyPair
The Amazon EC2 key pair of the infrastructure configuration.
public virtual string KeyPair { get; set; }
Property Value
System.String
Remarks
Logging
The logging configuration defines where Image Builder uploads your logs.
public virtual object Logging { get; set; }
Property Value
System.Object
Remarks
Name
The name of the infrastructure configuration.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
ResourceTags
The tags attached to the resource created by Image Builder.
public virtual object ResourceTags { get; set; }
Property Value
System.Object
Remarks
SecurityGroupIds
The security group IDs of the infrastructure configuration.
public virtual string[] SecurityGroupIds { get; set; }
Property Value
System.String[]
Remarks
SnsTopicArn
The Amazon Resource Name (ARN) of the SNS topic for the infrastructure configuration.
public virtual string SnsTopicArn { get; set; }
Property Value
System.String
Remarks
SubnetId
The subnet ID of the infrastructure configuration.
public virtual string SubnetId { get; set; }
Property Value
System.String
Remarks
Tags
The tags of the infrastructure configuration.
public virtual TagManager Tags { get; }
Property Value
Remarks
TerminateInstanceOnFailure
The terminate instance on failure configuration of the infrastructure configuration.
public virtual object TerminateInstanceOnFailure { get; set; }
Property Value
System.Object
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>