Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. awsconnector
  5. getKmsAlias
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.awsconnector.getKmsAlias

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

    Get a KmsAlias Azure REST API version: 2024-12-01.

    Using getKmsAlias

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getKmsAlias(args: GetKmsAliasArgs, opts?: InvokeOptions): Promise<GetKmsAliasResult>
function getKmsAliasOutput(args: GetKmsAliasOutputArgs, opts?: InvokeOptions): Output<GetKmsAliasResult>
    def get_kms_alias(name: Optional[str] = None,
                  resource_group_name: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetKmsAliasResult
def get_kms_alias_output(name: Optional[pulumi.Input[str]] = None,
                  resource_group_name: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetKmsAliasResult]
    func LookupKmsAlias(ctx *Context, args *LookupKmsAliasArgs, opts ...InvokeOption) (*LookupKmsAliasResult, error)
func LookupKmsAliasOutput(ctx *Context, args *LookupKmsAliasOutputArgs, opts ...InvokeOption) LookupKmsAliasResultOutput

    > Note: This function is named LookupKmsAlias in the Go SDK.

    public static class GetKmsAlias 
{
    public static Task<GetKmsAliasResult> InvokeAsync(GetKmsAliasArgs args, InvokeOptions? opts = null)
    public static Output<GetKmsAliasResult> Invoke(GetKmsAliasInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetKmsAliasResult> getKmsAlias(GetKmsAliasArgs args, InvokeOptions options)
public static Output<GetKmsAliasResult> getKmsAlias(GetKmsAliasArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:awsconnector:getKmsAlias
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Name string
    Name of KmsAlias
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    Name string
    Name of KmsAlias
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    name String
    Name of KmsAlias
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    name string
    Name of KmsAlias
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    name str
    Name of KmsAlias
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    name String
    Name of KmsAlias
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getKmsAlias Result

    The following output properties are available:

    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    Properties Pulumi.AzureNative.AwsConnector.Outputs.KmsAliasPropertiesResponse
    The resource-specific properties for this resource.
    SystemData Pulumi.AzureNative.AwsConnector.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Tags Dictionary<string, string>
    Resource tags.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    Properties KmsAliasPropertiesResponse
    The resource-specific properties for this resource.
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Tags map[string]string
    Resource tags.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    properties KmsAliasPropertiesResponse
    The resource-specific properties for this resource.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    tags Map<String,String>
    Resource tags.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    properties KmsAliasPropertiesResponse
    The resource-specific properties for this resource.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    tags {[key: string]: string}
    Resource tags.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    properties KmsAliasPropertiesResponse
    The resource-specific properties for this resource.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    tags Mapping[str, str]
    Resource tags.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    properties Property Map
    The resource-specific properties for this resource.
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    tags Map<String>
    Resource tags.

    Supporting Types

    AwsKmsAliasPropertiesResponse

    AliasName string
    Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. If you change the value of the AliasName property, the existing alias is deleted and a new alias is created for the specified KMS key. This change can disrupt applications that use the alias. It can also allow or deny access to a KMS key affected by attribute-based access control (ABAC). The alias must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for .
    TargetKeyId string
    Associates the alias with the specified . The KMS key must be in the same AWS-account and Region. A valid key ID is required. If you supply a null or empty string value, this operation returns an error. For help finding the key ID and ARN, see Finding the key ID and ARN in the Developer Guide. Specify the key ID or the key ARN of the KMS key. For example: + Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
    AliasName string
    Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. If you change the value of the AliasName property, the existing alias is deleted and a new alias is created for the specified KMS key. This change can disrupt applications that use the alias. It can also allow or deny access to a KMS key affected by attribute-based access control (ABAC). The alias must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for .
    TargetKeyId string
    Associates the alias with the specified . The KMS key must be in the same AWS-account and Region. A valid key ID is required. If you supply a null or empty string value, this operation returns an error. For help finding the key ID and ARN, see Finding the key ID and ARN in the Developer Guide. Specify the key ID or the key ARN of the KMS key. For example: + Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
    aliasName String
    Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. If you change the value of the AliasName property, the existing alias is deleted and a new alias is created for the specified KMS key. This change can disrupt applications that use the alias. It can also allow or deny access to a KMS key affected by attribute-based access control (ABAC). The alias must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for .
    targetKeyId String
    Associates the alias with the specified . The KMS key must be in the same AWS-account and Region. A valid key ID is required. If you supply a null or empty string value, this operation returns an error. For help finding the key ID and ARN, see Finding the key ID and ARN in the Developer Guide. Specify the key ID or the key ARN of the KMS key. For example: + Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
    aliasName string
    Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. If you change the value of the AliasName property, the existing alias is deleted and a new alias is created for the specified KMS key. This change can disrupt applications that use the alias. It can also allow or deny access to a KMS key affected by attribute-based access control (ABAC). The alias must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for .
    targetKeyId string
    Associates the alias with the specified . The KMS key must be in the same AWS-account and Region. A valid key ID is required. If you supply a null or empty string value, this operation returns an error. For help finding the key ID and ARN, see Finding the key ID and ARN in the Developer Guide. Specify the key ID or the key ARN of the KMS key. For example: + Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
    alias_name str
    Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. If you change the value of the AliasName property, the existing alias is deleted and a new alias is created for the specified KMS key. This change can disrupt applications that use the alias. It can also allow or deny access to a KMS key affected by attribute-based access control (ABAC). The alias must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for .
    target_key_id str
    Associates the alias with the specified . The KMS key must be in the same AWS-account and Region. A valid key ID is required. If you supply a null or empty string value, this operation returns an error. For help finding the key ID and ARN, see Finding the key ID and ARN in the Developer Guide. Specify the key ID or the key ARN of the KMS key. For example: + Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
    aliasName String
    Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. If you change the value of the AliasName property, the existing alias is deleted and a new alias is created for the specified KMS key. This change can disrupt applications that use the alias. It can also allow or deny access to a KMS key affected by attribute-based access control (ABAC). The alias must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for .
    targetKeyId String
    Associates the alias with the specified . The KMS key must be in the same AWS-account and Region. A valid key ID is required. If you supply a null or empty string value, this operation returns an error. For help finding the key ID and ARN, see Finding the key ID and ARN in the Developer Guide. Specify the key ID or the key ARN of the KMS key. For example: + Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

    KmsAliasPropertiesResponse

    ProvisioningState string
    The status of the last operation.
    Arn string
    Amazon Resource Name (ARN)
    AwsAccountId string
    AWS Account ID
    AwsProperties Pulumi.AzureNative.AwsConnector.Inputs.AwsKmsAliasPropertiesResponse
    AWS Properties
    AwsRegion string
    AWS Region
    AwsSourceSchema string
    AWS Source Schema
    AwsTags Dictionary<string, string>
    AWS Tags
    PublicCloudConnectorsResourceId string
    Public Cloud Connectors Resource ID
    PublicCloudResourceName string
    Public Cloud Resource Name
    ProvisioningState string
    The status of the last operation.
    Arn string
    Amazon Resource Name (ARN)
    AwsAccountId string
    AWS Account ID
    AwsProperties AwsKmsAliasPropertiesResponse
    AWS Properties
    AwsRegion string
    AWS Region
    AwsSourceSchema string
    AWS Source Schema
    AwsTags map[string]string
    AWS Tags
    PublicCloudConnectorsResourceId string
    Public Cloud Connectors Resource ID
    PublicCloudResourceName string
    Public Cloud Resource Name
    provisioningState String
    The status of the last operation.
    arn String
    Amazon Resource Name (ARN)
    awsAccountId String
    AWS Account ID
    awsProperties AwsKmsAliasPropertiesResponse
    AWS Properties
    awsRegion String
    AWS Region
    awsSourceSchema String
    AWS Source Schema
    awsTags Map<String,String>
    AWS Tags
    publicCloudConnectorsResourceId String
    Public Cloud Connectors Resource ID
    publicCloudResourceName String
    Public Cloud Resource Name
    provisioningState string
    The status of the last operation.
    arn string
    Amazon Resource Name (ARN)
    awsAccountId string
    AWS Account ID
    awsProperties AwsKmsAliasPropertiesResponse
    AWS Properties
    awsRegion string
    AWS Region
    awsSourceSchema string
    AWS Source Schema
    awsTags {[key: string]: string}
    AWS Tags
    publicCloudConnectorsResourceId string
    Public Cloud Connectors Resource ID
    publicCloudResourceName string
    Public Cloud Resource Name
    provisioning_state str
    The status of the last operation.
    arn str
    Amazon Resource Name (ARN)
    aws_account_id str
    AWS Account ID
    aws_properties AwsKmsAliasPropertiesResponse
    AWS Properties
    aws_region str
    AWS Region
    aws_source_schema str
    AWS Source Schema
    aws_tags Mapping[str, str]
    AWS Tags
    public_cloud_connectors_resource_id str
    Public Cloud Connectors Resource ID
    public_cloud_resource_name str
    Public Cloud Resource Name
    provisioningState String
    The status of the last operation.
    arn String
    Amazon Resource Name (ARN)
    awsAccountId String
    AWS Account ID
    awsProperties Property Map
    AWS Properties
    awsRegion String
    AWS Region
    awsSourceSchema String
    AWS Source Schema
    awsTags Map<String>
    AWS Tags
    publicCloudConnectorsResourceId String
    Public Cloud Connectors Resource ID
    publicCloudResourceName String
    Public Cloud Resource Name

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
    pulumi/pulumi-azure-native