CfnInfrastructureConfigurationProps

class aws_cdk.aws_imagebuilder.CfnInfrastructureConfigurationProps(*, instance_profile_name, name, description=None, instance_metadata_options=None, instance_types=None, key_pair=None, logging=None, resource_tags=None, security_group_ids=None, sns_topic_arn=None, subnet_id=None, tags=None, terminate_instance_on_failure=None)

Bases: object

Properties for defining a CfnInfrastructureConfiguration.

Parameters
  • instance_profile_name (str) – The instance profile of the infrastructure configuration.

  • name (str) – The name of the infrastructure configuration.

  • description (Optional[str]) – The description of the infrastructure configuration.

  • instance_metadata_options (Union[IResolvable, InstanceMetadataOptionsProperty, Dict[str, Any], None]) – The instance metadata option settings for the infrastructure configuration.

  • instance_types (Optional[Sequence[str]]) – The instance types of the infrastructure configuration.

  • key_pair (Optional[str]) – The Amazon EC2 key pair of the infrastructure configuration.

  • logging (Union[IResolvable, LoggingProperty, Dict[str, Any], None]) – The logging configuration defines where Image Builder uploads your logs.

  • resource_tags (Union[IResolvable, Mapping[str, str], None]) – The tags attached to the resource created by Image Builder.

  • security_group_ids (Optional[Sequence[str]]) – The security group IDs of the infrastructure configuration.

  • sns_topic_arn (Optional[str]) – The Amazon Resource Name (ARN) of the SNS topic for the infrastructure configuration.

  • subnet_id (Optional[str]) – The subnet ID of the infrastructure configuration.

  • tags (Optional[Mapping[str, str]]) – The tags of the infrastructure configuration.

  • terminate_instance_on_failure (Union[bool, IResolvable, None]) – The terminate instance on failure configuration of the infrastructure configuration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_imagebuilder as imagebuilder

cfn_infrastructure_configuration_props = imagebuilder.CfnInfrastructureConfigurationProps(
    instance_profile_name="instanceProfileName",
    name="name",

    # the properties below are optional
    description="description",
    instance_metadata_options=imagebuilder.CfnInfrastructureConfiguration.InstanceMetadataOptionsProperty(
        http_put_response_hop_limit=123,
        http_tokens="httpTokens"
    ),
    instance_types=["instanceTypes"],
    key_pair="keyPair",
    logging=imagebuilder.CfnInfrastructureConfiguration.LoggingProperty(
        s3_logs=imagebuilder.CfnInfrastructureConfiguration.S3LogsProperty(
            s3_bucket_name="s3BucketName",
            s3_key_prefix="s3KeyPrefix"
        )
    ),
    resource_tags={
        "resource_tags_key": "resourceTags"
    },
    security_group_ids=["securityGroupIds"],
    sns_topic_arn="snsTopicArn",
    subnet_id="subnetId",
    tags={
        "tags_key": "tags"
    },
    terminate_instance_on_failure=False
)

Attributes

description

The description of the infrastructure configuration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-description

Return type

Optional[str]

instance_metadata_options

The instance metadata option settings for the infrastructure configuration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-instancemetadataoptions

Return type

Union[IResolvable, InstanceMetadataOptionsProperty, None]

instance_profile_name

The instance profile of the infrastructure configuration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-instanceprofilename

Return type

str

instance_types

The instance types of the infrastructure configuration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-instancetypes

Return type

Optional[List[str]]

key_pair

The Amazon EC2 key pair of the infrastructure configuration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-keypair

Return type

Optional[str]

logging

The logging configuration defines where Image Builder uploads your logs.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-logging

Return type

Union[IResolvable, LoggingProperty, None]

name

The name of the infrastructure configuration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-name

Return type

str

resource_tags

The tags attached to the resource created by Image Builder.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-resourcetags

Return type

Union[IResolvable, Mapping[str, str], None]

security_group_ids

The security group IDs of the infrastructure configuration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-securitygroupids

Return type

Optional[List[str]]

sns_topic_arn

The Amazon Resource Name (ARN) of the SNS topic for the infrastructure configuration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-snstopicarn

Return type

Optional[str]

subnet_id

The subnet ID of the infrastructure configuration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-subnetid

Return type

Optional[str]

tags

The tags of the infrastructure configuration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-tags

Return type

Optional[Mapping[str, str]]

terminate_instance_on_failure

The terminate instance on failure configuration of the infrastructure configuration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-terminateinstanceonfailure

Return type

Union[bool, IResolvable, None]