github.com/pulumi/pulumi-aws/sdk/v6@v6.32.0/go/aws/appconfig/getEnvironment.go (about)

     1  // Code generated by the Pulumi Terraform Bridge (tfgen) Tool DO NOT EDIT.
     2  // *** WARNING: Do not edit by hand unless you're certain you know what you are doing! ***
     3  
     4  package appconfig
     5  
     6  import (
     7  	"context"
     8  	"reflect"
     9  
    10  	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/internal"
    11  	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    12  )
    13  
    14  // Provides access to an AppConfig Environment.
    15  //
    16  // ## Example Usage
    17  //
    18  // ### Basic Usage
    19  //
    20  // <!--Start PulumiCodeChooser -->
    21  // ```go
    22  // package main
    23  //
    24  // import (
    25  //
    26  //	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/appconfig"
    27  //	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    28  //
    29  // )
    30  //
    31  //	func main() {
    32  //		pulumi.Run(func(ctx *pulumi.Context) error {
    33  //			_, err := appconfig.LookupEnvironment(ctx, &appconfig.LookupEnvironmentArgs{
    34  //				ApplicationId: "b5d5gpj",
    35  //				EnvironmentId: "qrbb1c1",
    36  //			}, nil)
    37  //			if err != nil {
    38  //				return err
    39  //			}
    40  //			return nil
    41  //		})
    42  //	}
    43  //
    44  // ```
    45  // <!--End PulumiCodeChooser -->
    46  func LookupEnvironment(ctx *pulumi.Context, args *LookupEnvironmentArgs, opts ...pulumi.InvokeOption) (*LookupEnvironmentResult, error) {
    47  	opts = internal.PkgInvokeDefaultOpts(opts)
    48  	var rv LookupEnvironmentResult
    49  	err := ctx.Invoke("aws:appconfig/getEnvironment:getEnvironment", args, &rv, opts...)
    50  	if err != nil {
    51  		return nil, err
    52  	}
    53  	return &rv, nil
    54  }
    55  
    56  // A collection of arguments for invoking getEnvironment.
    57  type LookupEnvironmentArgs struct {
    58  	// ID of the AppConfig Application to which this Environment belongs.
    59  	ApplicationId string `pulumi:"applicationId"`
    60  	// ID of the AppConfig Environment.
    61  	EnvironmentId string `pulumi:"environmentId"`
    62  	// Map of tags for the resource.
    63  	Tags map[string]string `pulumi:"tags"`
    64  }
    65  
    66  // A collection of values returned by getEnvironment.
    67  type LookupEnvironmentResult struct {
    68  	ApplicationId string `pulumi:"applicationId"`
    69  	// ARN of the environment.
    70  	Arn string `pulumi:"arn"`
    71  	// Name of the environment.
    72  	Description   string `pulumi:"description"`
    73  	EnvironmentId string `pulumi:"environmentId"`
    74  	// The provider-assigned unique ID for this managed resource.
    75  	Id string `pulumi:"id"`
    76  	// Set of Amazon CloudWatch alarms to monitor during the deployment process.
    77  	Monitors []GetEnvironmentMonitor `pulumi:"monitors"`
    78  	// Name of the environment.
    79  	Name string `pulumi:"name"`
    80  	// State of the environment. Possible values are `READY_FOR_DEPLOYMENT`, `DEPLOYING`, `ROLLING_BACK`
    81  	// or `ROLLED_BACK`.
    82  	State string `pulumi:"state"`
    83  	// Map of tags for the resource.
    84  	Tags map[string]string `pulumi:"tags"`
    85  }
    86  
    87  func LookupEnvironmentOutput(ctx *pulumi.Context, args LookupEnvironmentOutputArgs, opts ...pulumi.InvokeOption) LookupEnvironmentResultOutput {
    88  	return pulumi.ToOutputWithContext(context.Background(), args).
    89  		ApplyT(func(v interface{}) (LookupEnvironmentResult, error) {
    90  			args := v.(LookupEnvironmentArgs)
    91  			r, err := LookupEnvironment(ctx, &args, opts...)
    92  			var s LookupEnvironmentResult
    93  			if r != nil {
    94  				s = *r
    95  			}
    96  			return s, err
    97  		}).(LookupEnvironmentResultOutput)
    98  }
    99  
   100  // A collection of arguments for invoking getEnvironment.
   101  type LookupEnvironmentOutputArgs struct {
   102  	// ID of the AppConfig Application to which this Environment belongs.
   103  	ApplicationId pulumi.StringInput `pulumi:"applicationId"`
   104  	// ID of the AppConfig Environment.
   105  	EnvironmentId pulumi.StringInput `pulumi:"environmentId"`
   106  	// Map of tags for the resource.
   107  	Tags pulumi.StringMapInput `pulumi:"tags"`
   108  }
   109  
   110  func (LookupEnvironmentOutputArgs) ElementType() reflect.Type {
   111  	return reflect.TypeOf((*LookupEnvironmentArgs)(nil)).Elem()
   112  }
   113  
   114  // A collection of values returned by getEnvironment.
   115  type LookupEnvironmentResultOutput struct{ *pulumi.OutputState }
   116  
   117  func (LookupEnvironmentResultOutput) ElementType() reflect.Type {
   118  	return reflect.TypeOf((*LookupEnvironmentResult)(nil)).Elem()
   119  }
   120  
   121  func (o LookupEnvironmentResultOutput) ToLookupEnvironmentResultOutput() LookupEnvironmentResultOutput {
   122  	return o
   123  }
   124  
   125  func (o LookupEnvironmentResultOutput) ToLookupEnvironmentResultOutputWithContext(ctx context.Context) LookupEnvironmentResultOutput {
   126  	return o
   127  }
   128  
   129  func (o LookupEnvironmentResultOutput) ApplicationId() pulumi.StringOutput {
   130  	return o.ApplyT(func(v LookupEnvironmentResult) string { return v.ApplicationId }).(pulumi.StringOutput)
   131  }
   132  
   133  // ARN of the environment.
   134  func (o LookupEnvironmentResultOutput) Arn() pulumi.StringOutput {
   135  	return o.ApplyT(func(v LookupEnvironmentResult) string { return v.Arn }).(pulumi.StringOutput)
   136  }
   137  
   138  // Name of the environment.
   139  func (o LookupEnvironmentResultOutput) Description() pulumi.StringOutput {
   140  	return o.ApplyT(func(v LookupEnvironmentResult) string { return v.Description }).(pulumi.StringOutput)
   141  }
   142  
   143  func (o LookupEnvironmentResultOutput) EnvironmentId() pulumi.StringOutput {
   144  	return o.ApplyT(func(v LookupEnvironmentResult) string { return v.EnvironmentId }).(pulumi.StringOutput)
   145  }
   146  
   147  // The provider-assigned unique ID for this managed resource.
   148  func (o LookupEnvironmentResultOutput) Id() pulumi.StringOutput {
   149  	return o.ApplyT(func(v LookupEnvironmentResult) string { return v.Id }).(pulumi.StringOutput)
   150  }
   151  
   152  // Set of Amazon CloudWatch alarms to monitor during the deployment process.
   153  func (o LookupEnvironmentResultOutput) Monitors() GetEnvironmentMonitorArrayOutput {
   154  	return o.ApplyT(func(v LookupEnvironmentResult) []GetEnvironmentMonitor { return v.Monitors }).(GetEnvironmentMonitorArrayOutput)
   155  }
   156  
   157  // Name of the environment.
   158  func (o LookupEnvironmentResultOutput) Name() pulumi.StringOutput {
   159  	return o.ApplyT(func(v LookupEnvironmentResult) string { return v.Name }).(pulumi.StringOutput)
   160  }
   161  
   162  // State of the environment. Possible values are `READY_FOR_DEPLOYMENT`, `DEPLOYING`, `ROLLING_BACK`
   163  // or `ROLLED_BACK`.
   164  func (o LookupEnvironmentResultOutput) State() pulumi.StringOutput {
   165  	return o.ApplyT(func(v LookupEnvironmentResult) string { return v.State }).(pulumi.StringOutput)
   166  }
   167  
   168  // Map of tags for the resource.
   169  func (o LookupEnvironmentResultOutput) Tags() pulumi.StringMapOutput {
   170  	return o.ApplyT(func(v LookupEnvironmentResult) map[string]string { return v.Tags }).(pulumi.StringMapOutput)
   171  }
   172  
   173  func init() {
   174  	pulumi.RegisterOutputType(LookupEnvironmentResultOutput{})
   175  }