Azure Native v3.1.0, Apr 8 25

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

azure-native.awsconnector.getSsmParameter

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

Using getSsmParameter

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.

TypeScript
Python
Go
C#
Java
YAML

function getSsmParameter(args: GetSsmParameterArgs, opts?: InvokeOptions): Promise<GetSsmParameterResult>
function getSsmParameterOutput(args: GetSsmParameterOutputArgs, opts?: InvokeOptions): Output<GetSsmParameterResult>

def get_ssm_parameter(name: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetSsmParameterResult
def get_ssm_parameter_output(name: Optional[pulumi.Input[str]] = None,
                      resource_group_name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetSsmParameterResult]

func LookupSsmParameter(ctx *Context, args *LookupSsmParameterArgs, opts ...InvokeOption) (*LookupSsmParameterResult, error)
func LookupSsmParameterOutput(ctx *Context, args *LookupSsmParameterOutputArgs, opts ...InvokeOption) LookupSsmParameterResultOutput

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

public static class GetSsmParameter 
{
    public static Task<GetSsmParameterResult> InvokeAsync(GetSsmParameterArgs args, InvokeOptions? opts = null)
    public static Output<GetSsmParameterResult> Invoke(GetSsmParameterInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetSsmParameterResult> getSsmParameter(GetSsmParameterArgs args, InvokeOptions options)
public static Output<GetSsmParameterResult> getSsmParameter(GetSsmParameterArgs args, InvokeOptions options)

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

The following arguments are supported:

Name string: Name of SsmParameter
ResourceGroupName string: The name of the resource group. The name is case insensitive.

Name string: Name of SsmParameter
ResourceGroupName string: The name of the resource group. The name is case insensitive.

name String: Name of SsmParameter
resourceGroupName String: The name of the resource group. The name is case insensitive.

name string: Name of SsmParameter
resourceGroupName string: The name of the resource group. The name is case insensitive.

name str: Name of SsmParameter
resource_group_name str: The name of the resource group. The name is case insensitive.

name String: Name of SsmParameter
resourceGroupName String: The name of the resource group. The name is case insensitive.

getSsmParameter Result

The following output properties are available:

AzureApiVersion string: The Azure API version of the resource.
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.SsmParameterPropertiesResponse: 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.

AzureApiVersion string: The Azure API version of the resource.
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 SsmParameterPropertiesResponse: 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.

azureApiVersion String: The Azure API version of the resource.
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 SsmParameterPropertiesResponse: 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.

azureApiVersion string: The Azure API version of the resource.
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 SsmParameterPropertiesResponse: 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.

azure_api_version str: The Azure API version of the resource.
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 SsmParameterPropertiesResponse: 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.

azureApiVersion String: The Azure API version of the resource.
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

AwsSsmParameterPropertiesResponse

AllowedPattern string: A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: AllowedPattern=^\d+$
DataType string: The data type of the parameter, such as text or aws:ec2:image. The default is text.
Description string: Information about the parameter.
Name string: The name of the parameter. The maximum length constraint listed below includes capacity for additional system attributes that aren't part of the name. The maximum length for a parameter name, including the full length of the parameter Amazon Resource Name (ARN), is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters: arn:aws:ssm:us-east-2:111222333444:parameter/ExampleParameterName
Policies string: Information about the policies assigned to a parameter. Assigning parameter policies in the User Guide.
Tags object: Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs). Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a SYS parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter.
Tier string: The parameter tier.
Type string: The type of parameter.
Value string: The parameter value. If type is StringList, the system returns a comma-separated string with no spaces between commas in the Value field.

AllowedPattern string: A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: AllowedPattern=^\d+$
DataType string: The data type of the parameter, such as text or aws:ec2:image. The default is text.
Description string: Information about the parameter.
Name string: The name of the parameter. The maximum length constraint listed below includes capacity for additional system attributes that aren't part of the name. The maximum length for a parameter name, including the full length of the parameter Amazon Resource Name (ARN), is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters: arn:aws:ssm:us-east-2:111222333444:parameter/ExampleParameterName
Policies string: Information about the policies assigned to a parameter. Assigning parameter policies in the User Guide.
Tags interface{}: Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs). Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a SYS parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter.
Tier string: The parameter tier.
Type string: The type of parameter.
Value string: The parameter value. If type is StringList, the system returns a comma-separated string with no spaces between commas in the Value field.

allowedPattern String: A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: AllowedPattern=^\d+$
dataType String: The data type of the parameter, such as text or aws:ec2:image. The default is text.
description String: Information about the parameter.
name String: The name of the parameter. The maximum length constraint listed below includes capacity for additional system attributes that aren't part of the name. The maximum length for a parameter name, including the full length of the parameter Amazon Resource Name (ARN), is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters: arn:aws:ssm:us-east-2:111222333444:parameter/ExampleParameterName
policies String: Information about the policies assigned to a parameter. Assigning parameter policies in the User Guide.
tags Object: Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs). Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a SYS parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter.
tier String: The parameter tier.
type String: The type of parameter.
value String: The parameter value. If type is StringList, the system returns a comma-separated string with no spaces between commas in the Value field.

allowedPattern string: A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: AllowedPattern=^\d+$
dataType string: The data type of the parameter, such as text or aws:ec2:image. The default is text.
description string: Information about the parameter.
name string: The name of the parameter. The maximum length constraint listed below includes capacity for additional system attributes that aren't part of the name. The maximum length for a parameter name, including the full length of the parameter Amazon Resource Name (ARN), is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters: arn:aws:ssm:us-east-2:111222333444:parameter/ExampleParameterName
policies string: Information about the policies assigned to a parameter. Assigning parameter policies in the User Guide.
tags any: Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs). Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a SYS parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter.
tier string: The parameter tier.
type string: The type of parameter.
value string: The parameter value. If type is StringList, the system returns a comma-separated string with no spaces between commas in the Value field.

allowed_pattern str: A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: AllowedPattern=^\d+$
data_type str: The data type of the parameter, such as text or aws:ec2:image. The default is text.
description str: Information about the parameter.
name str: The name of the parameter. The maximum length constraint listed below includes capacity for additional system attributes that aren't part of the name. The maximum length for a parameter name, including the full length of the parameter Amazon Resource Name (ARN), is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters: arn:aws:ssm:us-east-2:111222333444:parameter/ExampleParameterName
policies str: Information about the policies assigned to a parameter. Assigning parameter policies in the User Guide.
tags Any: Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs). Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a SYS parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter.
tier str: The parameter tier.
type str: The type of parameter.
value str: The parameter value. If type is StringList, the system returns a comma-separated string with no spaces between commas in the Value field.

allowedPattern String: A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: AllowedPattern=^\d+$
dataType String: The data type of the parameter, such as text or aws:ec2:image. The default is text.
description String: Information about the parameter.
name String: The name of the parameter. The maximum length constraint listed below includes capacity for additional system attributes that aren't part of the name. The maximum length for a parameter name, including the full length of the parameter Amazon Resource Name (ARN), is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters: arn:aws:ssm:us-east-2:111222333444:parameter/ExampleParameterName
policies String: Information about the policies assigned to a parameter. Assigning parameter policies in the User Guide.
tags Any: Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs). Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a SYS parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter.
tier String: The parameter tier.
type String: The type of parameter.
value String: The parameter value. If type is StringList, the system returns a comma-separated string with no spaces between commas in the Value field.

SsmParameterPropertiesResponse

ProvisioningState string: The status of the last operation.
Arn string: Amazon Resource Name (ARN)
AwsAccountId string: AWS Account ID
AwsProperties Pulumi.AzureNative.AwsConnector.Inputs.AwsSsmParameterPropertiesResponse: 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 AwsSsmParameterPropertiesResponse: 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 AwsSsmParameterPropertiesResponse: 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 AwsSsmParameterPropertiesResponse: 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 AwsSsmParameterPropertiesResponse: 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

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

pulumi/pulumi-azure-native

azure-native.awsconnector.getSsmParameter

On this page

On this page

Using getSsmParameter

getSsmParameter Result

Supporting Types

AwsSsmParameterPropertiesResponse

SsmParameterPropertiesResponse

SystemDataResponse

Package Details

On this page

On this page