Documentation ¶
Overview ¶
The ebsvolume package contains a packer.Builder implementation that builds EBS volumes for Amazon EC2 using an ephemeral instance,
Code generated by "mapstructure-to-hcl2 -type Config,BlockDevice"; DO NOT EDIT.
Index ¶
Constants ¶
const BuilderId = "mitchellh.amazon.ebsvolume"
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Artifact ¶ added in v0.12.1
type Artifact struct { // A map of regions to EBS Volume IDs. Volumes EbsVolumes // BuilderId is the unique ID for the builder that created this AMI BuilderIdValue string // EC2 connection for performing API stuff. Conn *ec2.EC2 }
Artifact is an artifact implementation that contains built AMIs.
type BlockDevice ¶
type BlockDevice struct { awscommon.BlockDevice `mapstructure:",squash"` // Tags to apply to the volume. These are retained after the builder // completes. This is a [template engine](/docs/templates/engine.html), see // [Build template data](#build-template-data) for more information. Tags awscommon.TagMap `mapstructure:"tags" required:"false"` }
func (*BlockDevice) FlatMapstructure ¶ added in v1.5.0
func (*BlockDevice) FlatMapstructure() interface{ HCL2Spec() map[string]hcldec.Spec }
FlatMapstructure returns a new FlatBlockDevice. FlatBlockDevice is an auto-generated flat version of BlockDevice. Where the contents a fields with a `mapstructure:,squash` tag are bubbled up.
type BlockDevices ¶ added in v1.4.4
type BlockDevices []BlockDevice
func (BlockDevices) BuildEC2BlockDeviceMappings ¶ added in v1.4.4
func (bds BlockDevices) BuildEC2BlockDeviceMappings() []*ec2.BlockDeviceMapping
func (BlockDevices) Prepare ¶ added in v1.4.4
func (bds BlockDevices) Prepare(ctx *interpolate.Context) (errs []error)
type Builder ¶
type Builder struct {
// contains filtered or unexported fields
}
func (*Builder) ConfigSpec ¶ added in v1.5.0
func (b *Builder) ConfigSpec() hcldec.ObjectSpec
type Config ¶
type Config struct { common.PackerConfig `mapstructure:",squash"` awscommon.AccessConfig `mapstructure:",squash"` awscommon.RunConfig `mapstructure:",squash"` // Enable enhanced networking (ENA but not SriovNetSupport) on // HVM-compatible AMIs. If set, add `ec2:ModifyInstanceAttribute` to your // AWS IAM policy. Note: you must make sure enhanced networking is enabled // on your instance. See [Amazon's documentation on enabling enhanced // networking](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html#enabling_enhanced_networking). AMIENASupport config.Trilean `mapstructure:"ena_support" required:"false"` // Enable enhanced networking (SriovNetSupport but not ENA) on // HVM-compatible AMIs. If true, add `ec2:ModifyInstanceAttribute` to your // AWS IAM policy. Note: you must make sure enhanced networking is enabled // on your instance. See [Amazon's documentation on enabling enhanced // networking](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html#enabling_enhanced_networking). // Default `false`. AMISriovNetSupport bool `mapstructure:"sriov_support" required:"false"` // Add the block device mappings to the AMI. If you add instance store // volumes or EBS volumes in addition to the root device volume, the // created AMI will contain block device mapping information for those // volumes. Amazon creates snapshots of the source instance's root volume // and any other EBS volumes described here. When you launch an instance // from this new AMI, the instance automatically launches with these // additional volumes, and will restore them from snapshots taken from the // source instance. See the [BlockDevices](#block-devices-configuration) // documentation for fields. VolumeMappings BlockDevices `mapstructure:"ebs_volumes" required:"false"` // Tags to apply to the volumes of the instance that is *launched* to // create EBS Volumes. These tags will *not* appear in the tags of the // resulting EBS volumes unless they're duplicated under `tags` in the // `ebs_volumes` setting. This is a [template // engine](/docs/templates/engine.html), see [Build template // data](#build-template-data) for more information. // // Note: The tags specified here will be *temporarily* applied to volumes // specified in `ebs_volumes` - but only while the instance is being // created. Packer will replace all tags on the volume with the tags // configured in the `ebs_volumes` section as soon as the instance is // reported as 'ready'. VolumeRunTags awscommon.TagMap `mapstructure:"run_volume_tags"` // contains filtered or unexported fields }
func (*Config) FlatMapstructure ¶ added in v1.5.0
FlatMapstructure returns a new FlatConfig. FlatConfig is an auto-generated flat version of Config. Where the contents a fields with a `mapstructure:,squash` tag are bubbled up.
type EbsVolumes ¶ added in v0.12.1
map of region to list of volume IDs
type EngineVarsTemplate ¶ added in v1.3.4
type FlatBlockDevice ¶ added in v1.5.0
type FlatBlockDevice struct { DeleteOnTermination *bool `mapstructure:"delete_on_termination" required:"false" cty:"delete_on_termination"` DeviceName *string `mapstructure:"device_name" required:"false" cty:"device_name"` Encrypted *bool `mapstructure:"encrypted" required:"false" cty:"encrypted"` IOPS *int64 `mapstructure:"iops" required:"false" cty:"iops"` NoDevice *bool `mapstructure:"no_device" required:"false" cty:"no_device"` SnapshotId *string `mapstructure:"snapshot_id" required:"false" cty:"snapshot_id"` VirtualName *string `mapstructure:"virtual_name" required:"false" cty:"virtual_name"` VolumeType *string `mapstructure:"volume_type" required:"false" cty:"volume_type"` VolumeSize *int64 `mapstructure:"volume_size" required:"false" cty:"volume_size"` KmsKeyId *string `mapstructure:"kms_key_id" required:"false" cty:"kms_key_id"` Tags common.TagMap `mapstructure:"tags" required:"false" cty:"tags"` }
FlatBlockDevice is an auto-generated flat version of BlockDevice. Where the contents of a field with a `mapstructure:,squash` tag are bubbled up.
type FlatConfig ¶ added in v1.5.0
type FlatConfig struct { PackerBuildName *string `mapstructure:"packer_build_name" cty:"packer_build_name"` PackerBuilderType *string `mapstructure:"packer_builder_type" cty:"packer_builder_type"` PackerDebug *bool `mapstructure:"packer_debug" cty:"packer_debug"` PackerForce *bool `mapstructure:"packer_force" cty:"packer_force"` PackerOnError *string `mapstructure:"packer_on_error" cty:"packer_on_error"` PackerUserVars map[string]string `mapstructure:"packer_user_variables" cty:"packer_user_variables"` PackerSensitiveVars []string `mapstructure:"packer_sensitive_variables" cty:"packer_sensitive_variables"` AccessKey *string `mapstructure:"access_key" required:"true" cty:"access_key"` CustomEndpointEc2 *string `mapstructure:"custom_endpoint_ec2" required:"false" cty:"custom_endpoint_ec2"` DecodeAuthZMessages *bool `mapstructure:"decode_authorization_messages" required:"false" cty:"decode_authorization_messages"` InsecureSkipTLSVerify *bool `mapstructure:"insecure_skip_tls_verify" required:"false" cty:"insecure_skip_tls_verify"` MFACode *string `mapstructure:"mfa_code" required:"false" cty:"mfa_code"` ProfileName *string `mapstructure:"profile" required:"false" cty:"profile"` RawRegion *string `mapstructure:"region" required:"true" cty:"region"` SecretKey *string `mapstructure:"secret_key" required:"true" cty:"secret_key"` SkipValidation *bool `mapstructure:"skip_region_validation" required:"false" cty:"skip_region_validation"` SkipMetadataApiCheck *bool `mapstructure:"skip_metadata_api_check" cty:"skip_metadata_api_check"` Token *string `mapstructure:"token" required:"false" cty:"token"` VaultAWSEngine *common.FlatVaultAWSEngineOptions `mapstructure:"vault_aws_engine" required:"false" cty:"vault_aws_engine"` AssociatePublicIpAddress *bool `mapstructure:"associate_public_ip_address" required:"false" cty:"associate_public_ip_address"` AvailabilityZone *string `mapstructure:"availability_zone" required:"false" cty:"availability_zone"` BlockDurationMinutes *int64 `mapstructure:"block_duration_minutes" required:"false" cty:"block_duration_minutes"` DisableStopInstance *bool `mapstructure:"disable_stop_instance" required:"false" cty:"disable_stop_instance"` EbsOptimized *bool `mapstructure:"ebs_optimized" required:"false" cty:"ebs_optimized"` EnableT2Unlimited *bool `mapstructure:"enable_t2_unlimited" required:"false" cty:"enable_t2_unlimited"` IamInstanceProfile *string `mapstructure:"iam_instance_profile" required:"false" cty:"iam_instance_profile"` SkipProfileValidation *bool `mapstructure:"skip_profile_validation" required:"false" cty:"skip_profile_validation"` TemporaryIamInstanceProfilePolicyDocument *common.FlatPolicyDocument `` /* 131-byte string literal not displayed */ InstanceInitiatedShutdownBehavior *string `mapstructure:"shutdown_behavior" required:"false" cty:"shutdown_behavior"` InstanceType *string `mapstructure:"instance_type" required:"true" cty:"instance_type"` SecurityGroupFilter *common.FlatSecurityGroupFilterOptions `mapstructure:"security_group_filter" required:"false" cty:"security_group_filter"` RunTags map[string]string `mapstructure:"run_tags" required:"false" cty:"run_tags"` SecurityGroupId *string `mapstructure:"security_group_id" required:"false" cty:"security_group_id"` SecurityGroupIds []string `mapstructure:"security_group_ids" required:"false" cty:"security_group_ids"` SourceAmi *string `mapstructure:"source_ami" required:"true" cty:"source_ami"` SourceAmiFilter *common.FlatAmiFilterOptions `mapstructure:"source_ami_filter" required:"false" cty:"source_ami_filter"` SpotInstanceTypes []string `mapstructure:"spot_instance_types" required:"false" cty:"spot_instance_types"` SpotPrice *string `mapstructure:"spot_price" required:"false" cty:"spot_price"` SpotPriceAutoProduct *string `mapstructure:"spot_price_auto_product" required:"false" cty:"spot_price_auto_product"` SpotTags map[string]string `mapstructure:"spot_tags" required:"false" cty:"spot_tags"` SubnetFilter *common.FlatSubnetFilterOptions `mapstructure:"subnet_filter" required:"false" cty:"subnet_filter"` SubnetId *string `mapstructure:"subnet_id" required:"false" cty:"subnet_id"` TemporaryKeyPairName *string `mapstructure:"temporary_key_pair_name" required:"false" cty:"temporary_key_pair_name"` TemporarySGSourceCidrs []string `mapstructure:"temporary_security_group_source_cidrs" required:"false" cty:"temporary_security_group_source_cidrs"` UserData *string `mapstructure:"user_data" required:"false" cty:"user_data"` UserDataFile *string `mapstructure:"user_data_file" required:"false" cty:"user_data_file"` VpcFilter *common.FlatVpcFilterOptions `mapstructure:"vpc_filter" required:"false" cty:"vpc_filter"` VpcId *string `mapstructure:"vpc_id" required:"false" cty:"vpc_id"` WindowsPasswordTimeout *string `mapstructure:"windows_password_timeout" required:"false" cty:"windows_password_timeout"` Type *string `mapstructure:"communicator" cty:"communicator"` PauseBeforeConnect *string `mapstructure:"pause_before_connecting" cty:"pause_before_connecting"` SSHHost *string `mapstructure:"ssh_host" cty:"ssh_host"` SSHPort *int `mapstructure:"ssh_port" cty:"ssh_port"` SSHUsername *string `mapstructure:"ssh_username" cty:"ssh_username"` SSHPassword *string `mapstructure:"ssh_password" cty:"ssh_password"` SSHKeyPairName *string `mapstructure:"ssh_keypair_name" cty:"ssh_keypair_name"` SSHClearAuthorizedKeys *bool `mapstructure:"ssh_clear_authorized_keys" cty:"ssh_clear_authorized_keys"` SSHPrivateKeyFile *string `mapstructure:"ssh_private_key_file" cty:"ssh_private_key_file"` SSHPty *bool `mapstructure:"ssh_pty" cty:"ssh_pty"` SSHTimeout *string `mapstructure:"ssh_timeout" cty:"ssh_timeout"` SSHAgentAuth *bool `mapstructure:"ssh_agent_auth" cty:"ssh_agent_auth"` SSHDisableAgentForwarding *bool `mapstructure:"ssh_disable_agent_forwarding" cty:"ssh_disable_agent_forwarding"` SSHHandshakeAttempts *int `mapstructure:"ssh_handshake_attempts" cty:"ssh_handshake_attempts"` SSHBastionHost *string `mapstructure:"ssh_bastion_host" cty:"ssh_bastion_host"` SSHBastionPort *int `mapstructure:"ssh_bastion_port" cty:"ssh_bastion_port"` SSHBastionAgentAuth *bool `mapstructure:"ssh_bastion_agent_auth" cty:"ssh_bastion_agent_auth"` SSHBastionUsername *string `mapstructure:"ssh_bastion_username" cty:"ssh_bastion_username"` SSHBastionPassword *string `mapstructure:"ssh_bastion_password" cty:"ssh_bastion_password"` SSHBastionPrivateKeyFile *string `mapstructure:"ssh_bastion_private_key_file" cty:"ssh_bastion_private_key_file"` SSHFileTransferMethod *string `mapstructure:"ssh_file_transfer_method" cty:"ssh_file_transfer_method"` SSHProxyHost *string `mapstructure:"ssh_proxy_host" cty:"ssh_proxy_host"` SSHProxyPort *int `mapstructure:"ssh_proxy_port" cty:"ssh_proxy_port"` SSHProxyUsername *string `mapstructure:"ssh_proxy_username" cty:"ssh_proxy_username"` SSHProxyPassword *string `mapstructure:"ssh_proxy_password" cty:"ssh_proxy_password"` SSHKeepAliveInterval *string `mapstructure:"ssh_keep_alive_interval" cty:"ssh_keep_alive_interval"` SSHReadWriteTimeout *string `mapstructure:"ssh_read_write_timeout" cty:"ssh_read_write_timeout"` SSHRemoteTunnels []string `mapstructure:"ssh_remote_tunnels" cty:"ssh_remote_tunnels"` SSHLocalTunnels []string `mapstructure:"ssh_local_tunnels" cty:"ssh_local_tunnels"` SSHPublicKey []byte `mapstructure:"ssh_public_key" cty:"ssh_public_key"` SSHPrivateKey []byte `mapstructure:"ssh_private_key" cty:"ssh_private_key"` WinRMUser *string `mapstructure:"winrm_username" cty:"winrm_username"` WinRMPassword *string `mapstructure:"winrm_password" cty:"winrm_password"` WinRMHost *string `mapstructure:"winrm_host" cty:"winrm_host"` WinRMPort *int `mapstructure:"winrm_port" cty:"winrm_port"` WinRMTimeout *string `mapstructure:"winrm_timeout" cty:"winrm_timeout"` WinRMUseSSL *bool `mapstructure:"winrm_use_ssl" cty:"winrm_use_ssl"` WinRMInsecure *bool `mapstructure:"winrm_insecure" cty:"winrm_insecure"` WinRMUseNTLM *bool `mapstructure:"winrm_use_ntlm" cty:"winrm_use_ntlm"` SSHInterface *string `mapstructure:"ssh_interface" cty:"ssh_interface"` AMIENASupport *bool `mapstructure:"ena_support" required:"false" cty:"ena_support"` AMISriovNetSupport *bool `mapstructure:"sriov_support" required:"false" cty:"sriov_support"` VolumeMappings []FlatBlockDevice `mapstructure:"ebs_volumes" required:"false" cty:"ebs_volumes"` VolumeRunTags common.TagMap `mapstructure:"run_volume_tags" cty:"run_volume_tags"` }
FlatConfig is an auto-generated flat version of Config. Where the contents of a field with a `mapstructure:,squash` tag are bubbled up.