1. Packages
  2. AWS Native
  3. API Docs
  4. ssm
  5. getAssociation

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.101.0 published on Thursday, Apr 11, 2024 by Pulumi

aws-native.ssm.getAssociation

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.101.0 published on Thursday, Apr 11, 2024 by Pulumi

    The AWS::SSM::Association resource associates an SSM document in AWS Systems Manager with EC2 instances that contain a configuration agent to process the document.

    Using getAssociation

    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 getAssociation(args: GetAssociationArgs, opts?: InvokeOptions): Promise<GetAssociationResult>
    function getAssociationOutput(args: GetAssociationOutputArgs, opts?: InvokeOptions): Output<GetAssociationResult>
    def get_association(association_id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetAssociationResult
    def get_association_output(association_id: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetAssociationResult]
    func LookupAssociation(ctx *Context, args *LookupAssociationArgs, opts ...InvokeOption) (*LookupAssociationResult, error)
    func LookupAssociationOutput(ctx *Context, args *LookupAssociationOutputArgs, opts ...InvokeOption) LookupAssociationResultOutput

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

    public static class GetAssociation 
    {
        public static Task<GetAssociationResult> InvokeAsync(GetAssociationArgs args, InvokeOptions? opts = null)
        public static Output<GetAssociationResult> Invoke(GetAssociationInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAssociationResult> getAssociation(GetAssociationArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:ssm:getAssociation
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AssociationId string
    Unique identifier of the association.
    AssociationId string
    Unique identifier of the association.
    associationId String
    Unique identifier of the association.
    associationId string
    Unique identifier of the association.
    association_id str
    Unique identifier of the association.
    associationId String
    Unique identifier of the association.

    getAssociation Result

    The following output properties are available:

    ApplyOnlyAtCronInterval bool
    AssociationId string
    Unique identifier of the association.
    AssociationName string
    The name of the association.
    AutomationTargetParameterName string
    CalendarNames List<string>
    ComplianceSeverity Pulumi.AwsNative.Ssm.AssociationComplianceSeverity
    DocumentVersion string
    The version of the SSM document to associate with the target.
    InstanceId string
    The ID of the instance that the SSM document is associated with.
    MaxConcurrency string
    MaxErrors string
    Name string
    The name of the SSM document.
    OutputLocation Pulumi.AwsNative.Ssm.Outputs.AssociationInstanceAssociationOutputLocation
    Parameters Dictionary<string, ImmutableArray<string>>
    Parameter values that the SSM document uses at runtime.
    ScheduleExpression string
    A Cron or Rate expression that specifies when the association is applied to the target.
    ScheduleOffset int
    SyncCompliance Pulumi.AwsNative.Ssm.AssociationSyncCompliance
    Targets List<Pulumi.AwsNative.Ssm.Outputs.AssociationTarget>
    The targets that the SSM document sends commands to.
    ApplyOnlyAtCronInterval bool
    AssociationId string
    Unique identifier of the association.
    AssociationName string
    The name of the association.
    AutomationTargetParameterName string
    CalendarNames []string
    ComplianceSeverity AssociationComplianceSeverity
    DocumentVersion string
    The version of the SSM document to associate with the target.
    InstanceId string
    The ID of the instance that the SSM document is associated with.
    MaxConcurrency string
    MaxErrors string
    Name string
    The name of the SSM document.
    OutputLocation AssociationInstanceAssociationOutputLocation
    Parameters map[string][]string
    Parameter values that the SSM document uses at runtime.
    ScheduleExpression string
    A Cron or Rate expression that specifies when the association is applied to the target.
    ScheduleOffset int
    SyncCompliance AssociationSyncCompliance
    Targets []AssociationTarget
    The targets that the SSM document sends commands to.
    applyOnlyAtCronInterval Boolean
    associationId String
    Unique identifier of the association.
    associationName String
    The name of the association.
    automationTargetParameterName String
    calendarNames List<String>
    complianceSeverity AssociationComplianceSeverity
    documentVersion String
    The version of the SSM document to associate with the target.
    instanceId String
    The ID of the instance that the SSM document is associated with.
    maxConcurrency String
    maxErrors String
    name String
    The name of the SSM document.
    outputLocation AssociationInstanceAssociationOutputLocation
    parameters Map<String,List<String>>
    Parameter values that the SSM document uses at runtime.
    scheduleExpression String
    A Cron or Rate expression that specifies when the association is applied to the target.
    scheduleOffset Integer
    syncCompliance AssociationSyncCompliance
    targets List<AssociationTarget>
    The targets that the SSM document sends commands to.
    applyOnlyAtCronInterval boolean
    associationId string
    Unique identifier of the association.
    associationName string
    The name of the association.
    automationTargetParameterName string
    calendarNames string[]
    complianceSeverity AssociationComplianceSeverity
    documentVersion string
    The version of the SSM document to associate with the target.
    instanceId string
    The ID of the instance that the SSM document is associated with.
    maxConcurrency string
    maxErrors string
    name string
    The name of the SSM document.
    outputLocation AssociationInstanceAssociationOutputLocation
    parameters {[key: string]: string[]}
    Parameter values that the SSM document uses at runtime.
    scheduleExpression string
    A Cron or Rate expression that specifies when the association is applied to the target.
    scheduleOffset number
    syncCompliance AssociationSyncCompliance
    targets AssociationTarget[]
    The targets that the SSM document sends commands to.
    apply_only_at_cron_interval bool
    association_id str
    Unique identifier of the association.
    association_name str
    The name of the association.
    automation_target_parameter_name str
    calendar_names Sequence[str]
    compliance_severity AssociationComplianceSeverity
    document_version str
    The version of the SSM document to associate with the target.
    instance_id str
    The ID of the instance that the SSM document is associated with.
    max_concurrency str
    max_errors str
    name str
    The name of the SSM document.
    output_location AssociationInstanceAssociationOutputLocation
    parameters Mapping[str, Sequence[str]]
    Parameter values that the SSM document uses at runtime.
    schedule_expression str
    A Cron or Rate expression that specifies when the association is applied to the target.
    schedule_offset int
    sync_compliance AssociationSyncCompliance
    targets Sequence[AssociationTarget]
    The targets that the SSM document sends commands to.
    applyOnlyAtCronInterval Boolean
    associationId String
    Unique identifier of the association.
    associationName String
    The name of the association.
    automationTargetParameterName String
    calendarNames List<String>
    complianceSeverity "CRITICAL" | "HIGH" | "MEDIUM" | "LOW" | "UNSPECIFIED"
    documentVersion String
    The version of the SSM document to associate with the target.
    instanceId String
    The ID of the instance that the SSM document is associated with.
    maxConcurrency String
    maxErrors String
    name String
    The name of the SSM document.
    outputLocation Property Map
    parameters Map<List<String>>
    Parameter values that the SSM document uses at runtime.
    scheduleExpression String
    A Cron or Rate expression that specifies when the association is applied to the target.
    scheduleOffset Number
    syncCompliance "AUTO" | "MANUAL"
    targets List<Property Map>
    The targets that the SSM document sends commands to.

    Supporting Types

    AssociationComplianceSeverity

    AssociationInstanceAssociationOutputLocation

    AssociationS3OutputLocation

    AssociationSyncCompliance

    AssociationTarget

    Key string
    Values List<string>
    Key string
    Values []string
    key String
    values List<String>
    key string
    values string[]
    key str
    values Sequence[str]
    key String
    values List<String>

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.101.0 published on Thursday, Apr 11, 2024 by Pulumi