Documentation ¶
Index ¶
- type GetAmiArgs
- type GetAmiIdsArgs
- type GetAmiIdsResult
- type GetAmiResult
- type GetArnArgs
- type GetArnResult
- type GetAutoscalingGroupsArgs
- type GetAutoscalingGroupsResult
- type GetAvailabilityZoneArgs
- type GetAvailabilityZoneResult
- type GetAvailabilityZonesArgs
- type GetAvailabilityZonesResult
- type GetBillingServiceAccountResult
- type GetCallerIdentityResult
- type GetCanonicalUserIdResult
- type GetElasticIpArgs
- type GetElasticIpResult
- type GetIpRangesArgs
- type GetIpRangesResult
- type GetPartitionResult
- type GetPrefixListArgs
- type GetPrefixListResult
- type GetRegionArgs
- type GetRegionResult
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type GetAmiArgs ¶
type GetAmiArgs struct { // Limit search to users with *explicit* launch permission on // the image. Valid items are the numeric account ID or `self`. ExecutableUsers interface{} // One or more name/value pairs to filter off of. There are // several valid keys, for a full reference, check out // [describe-images in the AWS CLI reference][1]. Filters interface{} // If more than one result is returned, use the most // recent AMI. MostRecent interface{} // A regex string to apply to the AMI list returned // by AWS. This allows more advanced filtering not supported from the AWS API. This // filtering is done locally on what AWS returns, and could have a performance // impact if the result is large. It is recommended to combine this with other // options to narrow down the list AWS returns. NameRegex interface{} // Limit search to specific AMI owners. Valid items are the numeric // account ID, `amazon`, or `self`. Owners interface{} Tags interface{} }
A collection of arguments for invoking getAmi.
type GetAmiIdsArgs ¶
type GetAmiIdsArgs struct { // Limit search to users with *explicit* launch // permission on the image. Valid items are the numeric account ID or `self`. ExecutableUsers interface{} // One or more name/value pairs to filter off of. There // are several valid keys, for a full reference, check out // [describe-images in the AWS CLI reference][1]. Filters interface{} // A regex string to apply to the AMI list returned // by AWS. This allows more advanced filtering not supported from the AWS API. // This filtering is done locally on what AWS returns, and could have a performance // impact if the result is large. It is recommended to combine this with other // options to narrow down the list AWS returns. NameRegex interface{} // Limit search to specific AMI owners. Valid items are // the numeric account ID, `amazon`, or `self`. Owners interface{} // Used to sort AMIs by creation time. SortAscending interface{} }
A collection of arguments for invoking getAmiIds.
type GetAmiIdsResult ¶
type GetAmiIdsResult struct { Ids interface{} // id is the provider-assigned unique ID for this managed resource. Id interface{} }
A collection of values returned by getAmiIds.
func LookupAmiIds ¶
func LookupAmiIds(ctx *pulumi.Context, args *GetAmiIdsArgs) (*GetAmiIdsResult, error)
Use this data source to get a list of AMI IDs matching the specified criteria.
~> **NOTE:** The `owners` argument will be **required** in the next major version.
type GetAmiResult ¶
type GetAmiResult struct { // The OS architecture of the AMI (ie: `i386` or `x86_64`). Architecture interface{} // The block device mappings of the AMI. // * `block_device_mappings.#.device_name` - The physical name of the device. // * `block_device_mappings.#.ebs.delete_on_termination` - `true` if the EBS volume // will be deleted on termination. // * `block_device_mappings.#.ebs.encrypted` - `true` if the EBS volume // is encrypted. // * `block_device_mappings.#.ebs.iops` - `0` if the EBS volume is // not a provisioned IOPS image, otherwise the supported IOPS count. // * `block_device_mappings.#.ebs.snapshot_id` - The ID of the snapshot. // * `block_device_mappings.#.ebs.volume_size` - The size of the volume, in GiB. // * `block_device_mappings.#.ebs.volume_type` - The volume type. // * `block_device_mappings.#.no_device` - Suppresses the specified device // included in the block device mapping of the AMI. // * `block_device_mappings.#.virtual_name` - The virtual device name (for // instance stores). BlockDeviceMappings interface{} // The date and time the image was created. CreationDate interface{} // The description of the AMI that was provided during image // creation. Description interface{} // The hypervisor type of the image. Hypervisor interface{} // The ID of the AMI. Should be the same as the resource `id`. ImageId interface{} // The location of the AMI. ImageLocation interface{} // The AWS account alias (for example, `amazon`, `self`) or // the AWS account ID of the AMI owner. ImageOwnerAlias interface{} // The type of image. ImageType interface{} // The kernel associated with the image, if any. Only applicable // for machine images. KernelId interface{} // The name of the AMI that was provided during image creation. Name interface{} // The AWS account ID of the image owner. OwnerId interface{} // The value is Windows for `Windows` AMIs; otherwise blank. Platform interface{} // Any product codes associated with the AMI. // * `product_codes.#.product_code_id` - The product code. // * `product_codes.#.product_code_type` - The type of product code. ProductCodes interface{} // `true` if the image has public launch permissions. Public interface{} // The RAM disk associated with the image, if any. Only applicable // for machine images. RamdiskId interface{} // The device name of the root device. RootDeviceName interface{} // The type of root device (ie: `ebs` or `instance-store`). RootDeviceType interface{} // The snapshot id associated with the root device, if any // (only applies to `ebs` root devices). RootSnapshotId interface{} // Specifies whether enhanced networking is enabled. SriovNetSupport interface{} // The current state of the AMI. If the state is `available`, the image // is successfully registered and can be used to launch an instance. State interface{} // Describes a state change. Fields are `UNSET` if not available. // * `state_reason.code` - The reason code for the state change. // * `state_reason.message` - The message for the state change. StateReason interface{} // Any tags assigned to the image. // * `tags.#.key` - The key name of the tag. // * `tags.#.value` - The value of the tag. Tags interface{} // The type of virtualization of the AMI (ie: `hvm` or // `paravirtual`). VirtualizationType interface{} // id is the provider-assigned unique ID for this managed resource. Id interface{} }
A collection of values returned by getAmi.
func LookupAmi ¶
func LookupAmi(ctx *pulumi.Context, args *GetAmiArgs) (*GetAmiResult, error)
Use this data source to get the ID of a registered AMI for use in other resources.
~> **NOTE:** The `owners` argument will be **required** in the next major version.
type GetArnArgs ¶
type GetArnArgs struct {
// The ARN to parse.
Arn interface{}
}
A collection of arguments for invoking getArn.
type GetArnResult ¶
type GetArnResult struct { // The [ID](https://docs.aws.amazon.com/general/latest/gr/acct-identifiers.html) of the AWS account that owns the resource, without the hyphens. Account interface{} // The partition that the resource is in. Partition interface{} // The region the resource resides in. // Note that the ARNs for some resources do not require a region, so this component might be omitted. Region interface{} // The content of this part of the ARN varies by service. // It often includes an indicator of the type of resource—for example, an IAM user or Amazon RDS database —followed by a slash (/) or a colon (:), followed by the resource name itself. Resource interface{} // The [service namespace](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces) that identifies the AWS product. Service interface{} // id is the provider-assigned unique ID for this managed resource. Id interface{} }
A collection of values returned by getArn.
func LookupArn ¶
func LookupArn(ctx *pulumi.Context, args *GetArnArgs) (*GetArnResult, error)
Parses an Amazon Resource Name (ARN) into its constituent parts.
type GetAutoscalingGroupsArgs ¶
type GetAutoscalingGroupsArgs struct {
// A filter used to scope the list e.g. by tags. See [related docs](http://docs.aws.amazon.com/AutoScaling/latest/APIReference/API_Filter.html).
Filters interface{}
}
A collection of arguments for invoking getAutoscalingGroups.
type GetAutoscalingGroupsResult ¶
type GetAutoscalingGroupsResult struct { // A list of the Autoscaling Groups Arns in the current region. Arns interface{} // A list of the Autoscaling Groups in the current region. Names interface{} // id is the provider-assigned unique ID for this managed resource. Id interface{} }
A collection of values returned by getAutoscalingGroups.
func LookupAutoscalingGroups ¶
func LookupAutoscalingGroups(ctx *pulumi.Context, args *GetAutoscalingGroupsArgs) (*GetAutoscalingGroupsResult, error)
The Autoscaling Groups data source allows access to the list of AWS ASGs within a specific region. This will allow you to pass a list of AutoScaling Groups to other resources.
type GetAvailabilityZoneArgs ¶
type GetAvailabilityZoneArgs struct { // The full name of the availability zone to select. Name interface{} // A specific availability zone state to require. May // be any of `"available"`, `"information"` or `"impaired"`. State interface{} }
A collection of arguments for invoking getAvailabilityZone.
type GetAvailabilityZoneResult ¶
type GetAvailabilityZoneResult struct { // The name of the selected availability zone. Name interface{} // The part of the AZ name that appears after the region name, // uniquely identifying the AZ within its region. NameSuffix interface{} // The region where the selected availability zone resides. // This is always the region selected on the provider, since this data source // searches only within that region. Region interface{} // The current state of the AZ. State interface{} // id is the provider-assigned unique ID for this managed resource. Id interface{} }
A collection of values returned by getAvailabilityZone.
func LookupAvailabilityZone ¶
func LookupAvailabilityZone(ctx *pulumi.Context, args *GetAvailabilityZoneArgs) (*GetAvailabilityZoneResult, error)
`aws_availability_zone` provides details about a specific availability zone (AZ) in the current region.
This can be used both to validate an availability zone given in a variable and to split the AZ name into its component parts of an AWS region and an AZ identifier letter. The latter may be useful e.g. for implementing a consistent subnet numbering scheme across several regions by mapping both the region and the subnet letter to network numbers.
This is different from the `aws_availability_zones` (plural) data source, which provides a list of the available zones.
type GetAvailabilityZonesArgs ¶
type GetAvailabilityZonesArgs struct { // Allows to filter list of Availability Zones based on their // current state. Can be either `"available"`, `"information"`, `"impaired"` or // `"unavailable"`. By default the list includes a complete set of Availability Zones // to which the underlying AWS account has access, regardless of their state. State interface{} }
A collection of arguments for invoking getAvailabilityZones.
type GetAvailabilityZonesResult ¶
type GetAvailabilityZonesResult struct { // A list of the Availability Zone names available to the account. Names interface{} // id is the provider-assigned unique ID for this managed resource. Id interface{} }
A collection of values returned by getAvailabilityZones.
func LookupAvailabilityZones ¶
func LookupAvailabilityZones(ctx *pulumi.Context, args *GetAvailabilityZonesArgs) (*GetAvailabilityZonesResult, error)
The Availability Zones data source allows access to the list of AWS Availability Zones which can be accessed by an AWS account within the region configured in the provider.
This is different from the `aws_availability_zone` (singular) data source, which provides some details about a specific availability zone.
type GetBillingServiceAccountResult ¶
type GetBillingServiceAccountResult struct { // The ARN of the AWS billing service account. Arn interface{} // id is the provider-assigned unique ID for this managed resource. Id interface{} }
A collection of values returned by getBillingServiceAccount.
func LookupBillingServiceAccount ¶
func LookupBillingServiceAccount(ctx *pulumi.Context) (*GetBillingServiceAccountResult, error)
Use this data source to get the Account ID of the [AWS Billing and Cost Management Service Account](http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/billing-getting-started.html#step-2) for the purpose of whitelisting in S3 bucket policy.
type GetCallerIdentityResult ¶
type GetCallerIdentityResult struct { // The AWS Account ID number of the account that owns or contains the calling entity. AccountId interface{} // The AWS ARN associated with the calling entity. Arn interface{} // The unique identifier of the calling entity. UserId interface{} // id is the provider-assigned unique ID for this managed resource. Id interface{} }
A collection of values returned by getCallerIdentity.
func LookupCallerIdentity ¶
func LookupCallerIdentity(ctx *pulumi.Context) (*GetCallerIdentityResult, error)
Use this data source to get the access to the effective Account ID, User ID, and ARN in which Terraform is authorized.
type GetCanonicalUserIdResult ¶
type GetCanonicalUserIdResult struct { // The human-friendly name linked to the canonical user ID. DisplayName interface{} // id is the provider-assigned unique ID for this managed resource. Id interface{} }
A collection of values returned by getCanonicalUserId.
func LookupCanonicalUserId ¶
func LookupCanonicalUserId(ctx *pulumi.Context) (*GetCanonicalUserIdResult, error)
The Canonical User ID data source allows access to the [canonical user ID](http://docs.aws.amazon.com/general/latest/gr/acct-identifiers.html) for the effective account in which Terraform is working.
type GetElasticIpArgs ¶
type GetElasticIpArgs struct { // The allocation id of the specific EIP to retrieve. Id interface{} // The public IP of the specific EIP to retrieve. PublicIp interface{} }
A collection of arguments for invoking getElasticIp.
type GetElasticIpResult ¶
type GetElasticIpResult struct { Id interface{} PublicIp interface{} }
A collection of values returned by getElasticIp.
func LookupElasticIp ¶
func LookupElasticIp(ctx *pulumi.Context, args *GetElasticIpArgs) (*GetElasticIpResult, error)
`aws_eip` provides details about a specific Elastic IP.
This resource can prove useful when a module accepts an allocation ID or public IP as an input variable and needs to determine the other.
type GetIpRangesArgs ¶
type GetIpRangesArgs struct { // Filter IP ranges by regions (or include all regions, if // omitted). Valid items are `global` (for `cloudfront`) as well as all AWS regions // (e.g. `eu-central-1`) Regions interface{} // Filter IP ranges by services. Valid items are `amazon` // (for amazon.com), `cloudfront`, `codebuild`, `ec2`, `route53`, `route53_healthchecks` and `S3`. Services interface{} }
A collection of arguments for invoking getIpRanges.
type GetIpRangesResult ¶
type GetIpRangesResult struct { // The lexically ordered list of CIDR blocks. CidrBlocks interface{} // The publication time of the IP ranges (e.g. `2016-08-03-23-46-05`). CreateDate interface{} // The lexically ordered list of IPv6 CIDR blocks. Ipv6CidrBlocks interface{} // The publication time of the IP ranges, in Unix epoch time format // (e.g. `1470267965`). SyncToken interface{} // id is the provider-assigned unique ID for this managed resource. Id interface{} }
A collection of values returned by getIpRanges.
func LookupIpRanges ¶
func LookupIpRanges(ctx *pulumi.Context, args *GetIpRangesArgs) (*GetIpRangesResult, error)
Use this data source to get the [IP ranges][1] of various AWS products and services.
type GetPartitionResult ¶
type GetPartitionResult struct { Partition interface{} // id is the provider-assigned unique ID for this managed resource. Id interface{} }
A collection of values returned by getPartition.
func LookupPartition ¶
func LookupPartition(ctx *pulumi.Context) (*GetPartitionResult, error)
Use this data source to lookup current AWS partition in which Terraform is working
type GetPrefixListArgs ¶
type GetPrefixListArgs struct { // The name of the prefix list to select. Name interface{} // The ID of the prefix list to select. PrefixListId interface{} }
A collection of arguments for invoking getPrefixList.
type GetPrefixListResult ¶
type GetPrefixListResult struct { // The list of CIDR blocks for the AWS service associated // with the prefix list. CidrBlocks interface{} // The name of the selected prefix list. Name interface{} // id is the provider-assigned unique ID for this managed resource. Id interface{} }
A collection of values returned by getPrefixList.
func LookupPrefixList ¶
func LookupPrefixList(ctx *pulumi.Context, args *GetPrefixListArgs) (*GetPrefixListResult, error)
`aws_prefix_list` provides details about a specific prefix list (PL) in the current region.
This can be used both to validate a prefix list given in a variable and to obtain the CIDR blocks (IP address ranges) for the associated AWS service. The latter may be useful e.g. for adding network ACL rules.
type GetRegionArgs ¶
type GetRegionArgs struct { Current interface{} // The EC2 endpoint of the region to select. Endpoint interface{} // The full name of the region to select. Name interface{} }
A collection of arguments for invoking getRegion.
type GetRegionResult ¶
type GetRegionResult struct { // `true` if the selected region is the one configured on the // provider, or `false` otherwise. Current interface{} // The region's description in this format: "Location (Region name)". Description interface{} // The EC2 endpoint for the selected region. Endpoint interface{} // The name of the selected region. Name interface{} // id is the provider-assigned unique ID for this managed resource. Id interface{} }
A collection of values returned by getRegion.
func LookupRegion ¶
func LookupRegion(ctx *pulumi.Context, args *GetRegionArgs) (*GetRegionResult, error)
`aws_region` provides details about a specific AWS region.
As well as validating a given region name this resource can be used to discover the name of the region configured within the provider. The latter can be useful in a child module which is inheriting an AWS provider configuration from its parent module.