AwsFunctions

Functions

Link copied to clipboard
suspend fun getArn(argument: GetArnPlainArgs): GetArnResult

Parses an ARN into its constituent parts.

suspend fun getArn(argument: suspend GetArnPlainArgsBuilder.() -> Unit): GetArnResult
suspend fun getArn(arn: String, id: String? = null): GetArnResult
Link copied to clipboard

aws.getAvailabilityZone 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.getAvailabilityZones (plural) data source, which provides a list of the available zones.

suspend fun getAvailabilityZone(allAvailabilityZones: Boolean? = null, filters: List<GetAvailabilityZoneFilter>? = null, name: String? = null, state: String? = null, zoneId: String? = null): GetAvailabilityZoneResult
Link copied to clipboard

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.getAvailabilityZone (singular) data source, which provides some details about a specific availability zone.

suspend fun getAvailabilityZones(allAvailabilityZones: Boolean? = null, excludeNames: List<String>? = null, excludeZoneIds: List<String>? = null, filters: List<GetAvailabilityZonesFilter>? = null, state: String? = null): GetAvailabilityZonesResult
Link copied to clipboard

Use this data source to get the Account ID of the AWS Billing and Cost Management Service Account for the purpose of permitting in S3 bucket policy.

Link copied to clipboard

Use this data source to get the access to the effective Account ID, User ID, and ARN in which this provider is authorized.

Link copied to clipboard

Use this data source to get the default tags configured on the provider. With this data source, you can apply default tags to resources not directly managed by a resource, such as the instances underneath an Auto Scaling group or the volumes created for an EC2 instance.

suspend fun getDefaultTags(id: String? = null): GetDefaultTagsResult
Link copied to clipboard

Use this data source to get the IP ranges of various AWS products and services. For more information about the contents of this data source and required JSON syntax if referencing a custom URL, see the AWS IP Address Ranges documentation.

suspend fun getIpRanges(argument: suspend GetIpRangesPlainArgsBuilder.() -> Unit): GetIpRangesResult
suspend fun getIpRanges(id: String? = null, regions: List<String>? = null, services: List<String>, url: String? = null): GetIpRangesResult
Link copied to clipboard

Use this data source to lookup information about the current AWS partition in which the provider is working.

suspend fun getPartition(id: String? = null): GetPartitionResult
Link copied to clipboard

aws.getRegion 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.

suspend fun getRegion(argument: suspend GetRegionPlainArgsBuilder.() -> Unit): GetRegionResult
suspend fun getRegion(endpoint: String? = null, id: String? = null, name: String? = null): GetRegionResult
Link copied to clipboard

Provides information about AWS Regions. Can be used to filter regions i.e., by Opt-In status or only regions enabled for current account. To get details like endpoint and description of each region the data source can be combined with the aws.getRegion data source.

suspend fun getRegions(argument: suspend GetRegionsPlainArgsBuilder.() -> Unit): GetRegionsResult
suspend fun getRegions(allRegions: Boolean? = null, filters: List<GetRegionsFilter>? = null, id: String? = null): GetRegionsResult
Link copied to clipboard

Use this data source to compose and decompose AWS service DNS names.

suspend fun getService(argument: suspend GetServicePlainArgsBuilder.() -> Unit): GetServiceResult
suspend fun getService(dnsName: String? = null, id: String? = null, region: String? = null, reverseDnsName: String? = null, reverseDnsPrefix: String? = null, serviceId: String? = null): GetServiceResult
Link copied to clipboard

Use this data source to create a Service Principal Name for a service in a given region. Service Principal Names should always end in the standard global format: {servicename}.amazonaws.com. However, in some AWS partitions, AWS may expect a different format.

suspend fun getServicePrincipal(region: String? = null, serviceName: String): GetServicePrincipalResult