github.com/pulumi/pulumi-aws/sdk/v6@v6.32.0/go/aws/workspaces/connectionAlias.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 workspaces
     5  
     6  import (
     7  	"context"
     8  	"reflect"
     9  
    10  	"errors"
    11  	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/internal"
    12  	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    13  )
    14  
    15  // Resource for managing an AWS WorkSpaces Connection Alias.
    16  //
    17  // ## Example Usage
    18  //
    19  // ### Basic Usage
    20  //
    21  // <!--Start PulumiCodeChooser -->
    22  // ```go
    23  // package main
    24  //
    25  // import (
    26  //
    27  //	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/workspaces"
    28  //	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    29  //
    30  // )
    31  //
    32  //	func main() {
    33  //		pulumi.Run(func(ctx *pulumi.Context) error {
    34  //			_, err := workspaces.NewConnectionAlias(ctx, "example", &workspaces.ConnectionAliasArgs{
    35  //				ConnectionString: pulumi.String("testdomain.test"),
    36  //			})
    37  //			if err != nil {
    38  //				return err
    39  //			}
    40  //			return nil
    41  //		})
    42  //	}
    43  //
    44  // ```
    45  // <!--End PulumiCodeChooser -->
    46  //
    47  // ## Import
    48  //
    49  // Using `pulumi import`, import WorkSpaces Connection Alias using the connection alias ID. For example:
    50  //
    51  // ```sh
    52  // $ pulumi import aws:workspaces/connectionAlias:ConnectionAlias example rft-8012925589
    53  // ```
    54  type ConnectionAlias struct {
    55  	pulumi.CustomResourceState
    56  
    57  	// The connection string specified for the connection alias. The connection string must be in the form of a fully qualified domain name (FQDN), such as www.example.com.
    58  	ConnectionString pulumi.StringOutput `pulumi:"connectionString"`
    59  	// The identifier of the Amazon Web Services account that owns the connection alias.
    60  	OwnerAccountId pulumi.StringOutput `pulumi:"ownerAccountId"`
    61  	// The current state of the connection alias.
    62  	State pulumi.StringOutput `pulumi:"state"`
    63  	// A map of tags assigned to the WorkSpaces Connection Alias. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    64  	Tags pulumi.StringMapOutput `pulumi:"tags"`
    65  	// A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
    66  	//
    67  	// Deprecated: Please use `tags` instead.
    68  	TagsAll  pulumi.StringMapOutput           `pulumi:"tagsAll"`
    69  	Timeouts ConnectionAliasTimeoutsPtrOutput `pulumi:"timeouts"`
    70  }
    71  
    72  // NewConnectionAlias registers a new resource with the given unique name, arguments, and options.
    73  func NewConnectionAlias(ctx *pulumi.Context,
    74  	name string, args *ConnectionAliasArgs, opts ...pulumi.ResourceOption) (*ConnectionAlias, error) {
    75  	if args == nil {
    76  		return nil, errors.New("missing one or more required arguments")
    77  	}
    78  
    79  	if args.ConnectionString == nil {
    80  		return nil, errors.New("invalid value for required argument 'ConnectionString'")
    81  	}
    82  	opts = internal.PkgResourceDefaultOpts(opts)
    83  	var resource ConnectionAlias
    84  	err := ctx.RegisterResource("aws:workspaces/connectionAlias:ConnectionAlias", name, args, &resource, opts...)
    85  	if err != nil {
    86  		return nil, err
    87  	}
    88  	return &resource, nil
    89  }
    90  
    91  // GetConnectionAlias gets an existing ConnectionAlias resource's state with the given name, ID, and optional
    92  // state properties that are used to uniquely qualify the lookup (nil if not required).
    93  func GetConnectionAlias(ctx *pulumi.Context,
    94  	name string, id pulumi.IDInput, state *ConnectionAliasState, opts ...pulumi.ResourceOption) (*ConnectionAlias, error) {
    95  	var resource ConnectionAlias
    96  	err := ctx.ReadResource("aws:workspaces/connectionAlias:ConnectionAlias", name, id, state, &resource, opts...)
    97  	if err != nil {
    98  		return nil, err
    99  	}
   100  	return &resource, nil
   101  }
   102  
   103  // Input properties used for looking up and filtering ConnectionAlias resources.
   104  type connectionAliasState struct {
   105  	// The connection string specified for the connection alias. The connection string must be in the form of a fully qualified domain name (FQDN), such as www.example.com.
   106  	ConnectionString *string `pulumi:"connectionString"`
   107  	// The identifier of the Amazon Web Services account that owns the connection alias.
   108  	OwnerAccountId *string `pulumi:"ownerAccountId"`
   109  	// The current state of the connection alias.
   110  	State *string `pulumi:"state"`
   111  	// A map of tags assigned to the WorkSpaces Connection Alias. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
   112  	Tags map[string]string `pulumi:"tags"`
   113  	// A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
   114  	//
   115  	// Deprecated: Please use `tags` instead.
   116  	TagsAll  map[string]string        `pulumi:"tagsAll"`
   117  	Timeouts *ConnectionAliasTimeouts `pulumi:"timeouts"`
   118  }
   119  
   120  type ConnectionAliasState struct {
   121  	// The connection string specified for the connection alias. The connection string must be in the form of a fully qualified domain name (FQDN), such as www.example.com.
   122  	ConnectionString pulumi.StringPtrInput
   123  	// The identifier of the Amazon Web Services account that owns the connection alias.
   124  	OwnerAccountId pulumi.StringPtrInput
   125  	// The current state of the connection alias.
   126  	State pulumi.StringPtrInput
   127  	// A map of tags assigned to the WorkSpaces Connection Alias. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
   128  	Tags pulumi.StringMapInput
   129  	// A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
   130  	//
   131  	// Deprecated: Please use `tags` instead.
   132  	TagsAll  pulumi.StringMapInput
   133  	Timeouts ConnectionAliasTimeoutsPtrInput
   134  }
   135  
   136  func (ConnectionAliasState) ElementType() reflect.Type {
   137  	return reflect.TypeOf((*connectionAliasState)(nil)).Elem()
   138  }
   139  
   140  type connectionAliasArgs struct {
   141  	// The connection string specified for the connection alias. The connection string must be in the form of a fully qualified domain name (FQDN), such as www.example.com.
   142  	ConnectionString string `pulumi:"connectionString"`
   143  	// A map of tags assigned to the WorkSpaces Connection Alias. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
   144  	Tags     map[string]string        `pulumi:"tags"`
   145  	Timeouts *ConnectionAliasTimeouts `pulumi:"timeouts"`
   146  }
   147  
   148  // The set of arguments for constructing a ConnectionAlias resource.
   149  type ConnectionAliasArgs struct {
   150  	// The connection string specified for the connection alias. The connection string must be in the form of a fully qualified domain name (FQDN), such as www.example.com.
   151  	ConnectionString pulumi.StringInput
   152  	// A map of tags assigned to the WorkSpaces Connection Alias. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
   153  	Tags     pulumi.StringMapInput
   154  	Timeouts ConnectionAliasTimeoutsPtrInput
   155  }
   156  
   157  func (ConnectionAliasArgs) ElementType() reflect.Type {
   158  	return reflect.TypeOf((*connectionAliasArgs)(nil)).Elem()
   159  }
   160  
   161  type ConnectionAliasInput interface {
   162  	pulumi.Input
   163  
   164  	ToConnectionAliasOutput() ConnectionAliasOutput
   165  	ToConnectionAliasOutputWithContext(ctx context.Context) ConnectionAliasOutput
   166  }
   167  
   168  func (*ConnectionAlias) ElementType() reflect.Type {
   169  	return reflect.TypeOf((**ConnectionAlias)(nil)).Elem()
   170  }
   171  
   172  func (i *ConnectionAlias) ToConnectionAliasOutput() ConnectionAliasOutput {
   173  	return i.ToConnectionAliasOutputWithContext(context.Background())
   174  }
   175  
   176  func (i *ConnectionAlias) ToConnectionAliasOutputWithContext(ctx context.Context) ConnectionAliasOutput {
   177  	return pulumi.ToOutputWithContext(ctx, i).(ConnectionAliasOutput)
   178  }
   179  
   180  // ConnectionAliasArrayInput is an input type that accepts ConnectionAliasArray and ConnectionAliasArrayOutput values.
   181  // You can construct a concrete instance of `ConnectionAliasArrayInput` via:
   182  //
   183  //	ConnectionAliasArray{ ConnectionAliasArgs{...} }
   184  type ConnectionAliasArrayInput interface {
   185  	pulumi.Input
   186  
   187  	ToConnectionAliasArrayOutput() ConnectionAliasArrayOutput
   188  	ToConnectionAliasArrayOutputWithContext(context.Context) ConnectionAliasArrayOutput
   189  }
   190  
   191  type ConnectionAliasArray []ConnectionAliasInput
   192  
   193  func (ConnectionAliasArray) ElementType() reflect.Type {
   194  	return reflect.TypeOf((*[]*ConnectionAlias)(nil)).Elem()
   195  }
   196  
   197  func (i ConnectionAliasArray) ToConnectionAliasArrayOutput() ConnectionAliasArrayOutput {
   198  	return i.ToConnectionAliasArrayOutputWithContext(context.Background())
   199  }
   200  
   201  func (i ConnectionAliasArray) ToConnectionAliasArrayOutputWithContext(ctx context.Context) ConnectionAliasArrayOutput {
   202  	return pulumi.ToOutputWithContext(ctx, i).(ConnectionAliasArrayOutput)
   203  }
   204  
   205  // ConnectionAliasMapInput is an input type that accepts ConnectionAliasMap and ConnectionAliasMapOutput values.
   206  // You can construct a concrete instance of `ConnectionAliasMapInput` via:
   207  //
   208  //	ConnectionAliasMap{ "key": ConnectionAliasArgs{...} }
   209  type ConnectionAliasMapInput interface {
   210  	pulumi.Input
   211  
   212  	ToConnectionAliasMapOutput() ConnectionAliasMapOutput
   213  	ToConnectionAliasMapOutputWithContext(context.Context) ConnectionAliasMapOutput
   214  }
   215  
   216  type ConnectionAliasMap map[string]ConnectionAliasInput
   217  
   218  func (ConnectionAliasMap) ElementType() reflect.Type {
   219  	return reflect.TypeOf((*map[string]*ConnectionAlias)(nil)).Elem()
   220  }
   221  
   222  func (i ConnectionAliasMap) ToConnectionAliasMapOutput() ConnectionAliasMapOutput {
   223  	return i.ToConnectionAliasMapOutputWithContext(context.Background())
   224  }
   225  
   226  func (i ConnectionAliasMap) ToConnectionAliasMapOutputWithContext(ctx context.Context) ConnectionAliasMapOutput {
   227  	return pulumi.ToOutputWithContext(ctx, i).(ConnectionAliasMapOutput)
   228  }
   229  
   230  type ConnectionAliasOutput struct{ *pulumi.OutputState }
   231  
   232  func (ConnectionAliasOutput) ElementType() reflect.Type {
   233  	return reflect.TypeOf((**ConnectionAlias)(nil)).Elem()
   234  }
   235  
   236  func (o ConnectionAliasOutput) ToConnectionAliasOutput() ConnectionAliasOutput {
   237  	return o
   238  }
   239  
   240  func (o ConnectionAliasOutput) ToConnectionAliasOutputWithContext(ctx context.Context) ConnectionAliasOutput {
   241  	return o
   242  }
   243  
   244  // The connection string specified for the connection alias. The connection string must be in the form of a fully qualified domain name (FQDN), such as www.example.com.
   245  func (o ConnectionAliasOutput) ConnectionString() pulumi.StringOutput {
   246  	return o.ApplyT(func(v *ConnectionAlias) pulumi.StringOutput { return v.ConnectionString }).(pulumi.StringOutput)
   247  }
   248  
   249  // The identifier of the Amazon Web Services account that owns the connection alias.
   250  func (o ConnectionAliasOutput) OwnerAccountId() pulumi.StringOutput {
   251  	return o.ApplyT(func(v *ConnectionAlias) pulumi.StringOutput { return v.OwnerAccountId }).(pulumi.StringOutput)
   252  }
   253  
   254  // The current state of the connection alias.
   255  func (o ConnectionAliasOutput) State() pulumi.StringOutput {
   256  	return o.ApplyT(func(v *ConnectionAlias) pulumi.StringOutput { return v.State }).(pulumi.StringOutput)
   257  }
   258  
   259  // A map of tags assigned to the WorkSpaces Connection Alias. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
   260  func (o ConnectionAliasOutput) Tags() pulumi.StringMapOutput {
   261  	return o.ApplyT(func(v *ConnectionAlias) pulumi.StringMapOutput { return v.Tags }).(pulumi.StringMapOutput)
   262  }
   263  
   264  // A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
   265  //
   266  // Deprecated: Please use `tags` instead.
   267  func (o ConnectionAliasOutput) TagsAll() pulumi.StringMapOutput {
   268  	return o.ApplyT(func(v *ConnectionAlias) pulumi.StringMapOutput { return v.TagsAll }).(pulumi.StringMapOutput)
   269  }
   270  
   271  func (o ConnectionAliasOutput) Timeouts() ConnectionAliasTimeoutsPtrOutput {
   272  	return o.ApplyT(func(v *ConnectionAlias) ConnectionAliasTimeoutsPtrOutput { return v.Timeouts }).(ConnectionAliasTimeoutsPtrOutput)
   273  }
   274  
   275  type ConnectionAliasArrayOutput struct{ *pulumi.OutputState }
   276  
   277  func (ConnectionAliasArrayOutput) ElementType() reflect.Type {
   278  	return reflect.TypeOf((*[]*ConnectionAlias)(nil)).Elem()
   279  }
   280  
   281  func (o ConnectionAliasArrayOutput) ToConnectionAliasArrayOutput() ConnectionAliasArrayOutput {
   282  	return o
   283  }
   284  
   285  func (o ConnectionAliasArrayOutput) ToConnectionAliasArrayOutputWithContext(ctx context.Context) ConnectionAliasArrayOutput {
   286  	return o
   287  }
   288  
   289  func (o ConnectionAliasArrayOutput) Index(i pulumi.IntInput) ConnectionAliasOutput {
   290  	return pulumi.All(o, i).ApplyT(func(vs []interface{}) *ConnectionAlias {
   291  		return vs[0].([]*ConnectionAlias)[vs[1].(int)]
   292  	}).(ConnectionAliasOutput)
   293  }
   294  
   295  type ConnectionAliasMapOutput struct{ *pulumi.OutputState }
   296  
   297  func (ConnectionAliasMapOutput) ElementType() reflect.Type {
   298  	return reflect.TypeOf((*map[string]*ConnectionAlias)(nil)).Elem()
   299  }
   300  
   301  func (o ConnectionAliasMapOutput) ToConnectionAliasMapOutput() ConnectionAliasMapOutput {
   302  	return o
   303  }
   304  
   305  func (o ConnectionAliasMapOutput) ToConnectionAliasMapOutputWithContext(ctx context.Context) ConnectionAliasMapOutput {
   306  	return o
   307  }
   308  
   309  func (o ConnectionAliasMapOutput) MapIndex(k pulumi.StringInput) ConnectionAliasOutput {
   310  	return pulumi.All(o, k).ApplyT(func(vs []interface{}) *ConnectionAlias {
   311  		return vs[0].(map[string]*ConnectionAlias)[vs[1].(string)]
   312  	}).(ConnectionAliasOutput)
   313  }
   314  
   315  func init() {
   316  	pulumi.RegisterInputType(reflect.TypeOf((*ConnectionAliasInput)(nil)).Elem(), &ConnectionAlias{})
   317  	pulumi.RegisterInputType(reflect.TypeOf((*ConnectionAliasArrayInput)(nil)).Elem(), ConnectionAliasArray{})
   318  	pulumi.RegisterInputType(reflect.TypeOf((*ConnectionAliasMapInput)(nil)).Elem(), ConnectionAliasMap{})
   319  	pulumi.RegisterOutputType(ConnectionAliasOutput{})
   320  	pulumi.RegisterOutputType(ConnectionAliasArrayOutput{})
   321  	pulumi.RegisterOutputType(ConnectionAliasMapOutput{})
   322  }