AWS rules engine built-ins

AWS-specific rules engine built-ins make it possible to integrate with AWS concepts like Regions. An additional dependency is required to access these functions:

The following example adds smithy-aws-endpoints as a Gradle dependency to a Smithy project:

smithy-build.json
{
    "maven": {
        "dependencies": [
            "software.amazon.smithy:smithy-aws-endpoints:1.65.0"
        ]
    }
}
build.gradle.kts
dependencies {
    ...
    implementation("software.amazon.smithy:smithy-aws-endpoints:1.65.0")
    ...
}
build.gradle
dependencies {
    ...
    implementation 'software.amazon.smithy:smithy-aws-endpoints:1.65.0'
    ...
}

AWS::Region built-in

Description

The AWS region configured for the SDK client.

Type

string

AWS::UseDualStack built-in

Description

If the SDK client is configured to use dual stack endpoints, defaults to false.

Type

boolean

AWS::UseFIPS built-in

Description

If the SDK client is configured to use FIPS-compliant endpoints, defaults to false.

Type

boolean

AWS::Auth::AccountId built-in

Description

The AWS AccountId.

Type

string

AWS::Auth::AccountIdEndpointMode built-in

Description

The AccountId Endpoint Mode.

Type

string

AWS::Auth::CredentialScope built-in

Description

The AWS Credential Scope.

Type

string

AWS::S3::Accelerate built-in

Description

If the SDK client is configured to use S3 transfer acceleration, defaults to false.

Type

boolean

AWS::S3::DisableMultiRegionAccessPoints built-in

Description

If the SDK client is configured to not use S3's multi-region access points, defaults to false.

Type

boolean

AWS::S3::ForcePathStyle built-in

Description

If the SDK client is configured to use solely S3 path style routing, defaults to false.

Type

boolean

AWS::S3::UseArnRegion built-in

Description

If the SDK client is configured to use S3 bucket ARN regions or raise an error when the bucket ARN and client region differ, defaults to true.

Type

boolean

Important

SDKs MUST raise an error when the partitions of an ARN and the partition of the configured region differ.

AWS::S3::UseGlobalEndpoint built-in

Description

If the SDK client is configured to use S3's global endpoint instead of the regional us-east-1 endpoint, defaults to false.

Type

boolean

AWS::S3Control::UseArnRegion built-in

Description

If the SDK client is configured to use S3 Control bucket ARN regions or raise an error when the bucket ARN and client region differ, defaults to true.

Type

boolean

Important

SDKs MUST raise an error when the partitions of an ARN and the partition of the configured region differ.

AWS::STS::UseGlobalEndpoint built-in

Description

If the SDK client is configured to use STS' global endpoint instead of the regional us-east-1 endpoint, defaults to false.

Type

boolean