Documentation
¶
Index ¶
- type GetLinksResult
- type GetSinksResult
- type Link
- type LinkArgs
- type LinkArray
- type LinkArrayInput
- type LinkArrayOutput
- type LinkInput
- type LinkMap
- type LinkMapInput
- type LinkMapOutput
- type LinkOutput
- func (o LinkOutput) Arn() pulumi.StringOutput
- func (LinkOutput) ElementType() reflect.Type
- func (o LinkOutput) Label() pulumi.StringOutput
- func (o LinkOutput) LabelTemplate() pulumi.StringOutput
- func (o LinkOutput) LinkId() pulumi.StringOutput
- func (o LinkOutput) ResourceTypes() pulumi.StringArrayOutput
- func (o LinkOutput) SinkArn() pulumi.StringOutput
- func (o LinkOutput) SinkIdentifier() pulumi.StringOutput
- func (o LinkOutput) Tags() pulumi.StringMapOutput
- func (o LinkOutput) TagsAll() pulumi.StringMapOutput
- func (o LinkOutput) ToLinkOutput() LinkOutput
- func (o LinkOutput) ToLinkOutputWithContext(ctx context.Context) LinkOutput
- type LinkState
- type LookupLinkArgs
- type LookupLinkOutputArgs
- type LookupLinkResult
- type LookupLinkResultOutput
- func (o LookupLinkResultOutput) Arn() pulumi.StringOutput
- func (LookupLinkResultOutput) ElementType() reflect.Type
- func (o LookupLinkResultOutput) Id() pulumi.StringOutput
- func (o LookupLinkResultOutput) Label() pulumi.StringOutput
- func (o LookupLinkResultOutput) LabelTemplate() pulumi.StringOutput
- func (o LookupLinkResultOutput) LinkId() pulumi.StringOutput
- func (o LookupLinkResultOutput) LinkIdentifier() pulumi.StringOutput
- func (o LookupLinkResultOutput) ResourceTypes() pulumi.StringArrayOutput
- func (o LookupLinkResultOutput) SinkArn() pulumi.StringOutput
- func (o LookupLinkResultOutput) Tags() pulumi.StringMapOutput
- func (o LookupLinkResultOutput) ToLookupLinkResultOutput() LookupLinkResultOutput
- func (o LookupLinkResultOutput) ToLookupLinkResultOutputWithContext(ctx context.Context) LookupLinkResultOutput
- type LookupSinkArgs
- type LookupSinkOutputArgs
- type LookupSinkResult
- type LookupSinkResultOutput
- func (o LookupSinkResultOutput) Arn() pulumi.StringOutput
- func (LookupSinkResultOutput) ElementType() reflect.Type
- func (o LookupSinkResultOutput) Id() pulumi.StringOutput
- func (o LookupSinkResultOutput) Name() pulumi.StringOutput
- func (o LookupSinkResultOutput) SinkId() pulumi.StringOutput
- func (o LookupSinkResultOutput) SinkIdentifier() pulumi.StringOutput
- func (o LookupSinkResultOutput) Tags() pulumi.StringMapOutput
- func (o LookupSinkResultOutput) ToLookupSinkResultOutput() LookupSinkResultOutput
- func (o LookupSinkResultOutput) ToLookupSinkResultOutputWithContext(ctx context.Context) LookupSinkResultOutput
- type Sink
- type SinkArgs
- type SinkArray
- type SinkArrayInput
- type SinkArrayOutput
- type SinkInput
- type SinkMap
- type SinkMapInput
- type SinkMapOutput
- type SinkOutput
- func (o SinkOutput) Arn() pulumi.StringOutput
- func (SinkOutput) ElementType() reflect.Type
- func (o SinkOutput) Name() pulumi.StringOutput
- func (o SinkOutput) SinkId() pulumi.StringOutput
- func (o SinkOutput) Tags() pulumi.StringMapOutput
- func (o SinkOutput) TagsAll() pulumi.StringMapOutput
- func (o SinkOutput) ToSinkOutput() SinkOutput
- func (o SinkOutput) ToSinkOutputWithContext(ctx context.Context) SinkOutput
- type SinkPolicy
- type SinkPolicyArgs
- type SinkPolicyArray
- type SinkPolicyArrayInput
- type SinkPolicyArrayOutput
- func (SinkPolicyArrayOutput) ElementType() reflect.Type
- func (o SinkPolicyArrayOutput) Index(i pulumi.IntInput) SinkPolicyOutput
- func (o SinkPolicyArrayOutput) ToSinkPolicyArrayOutput() SinkPolicyArrayOutput
- func (o SinkPolicyArrayOutput) ToSinkPolicyArrayOutputWithContext(ctx context.Context) SinkPolicyArrayOutput
- type SinkPolicyInput
- type SinkPolicyMap
- type SinkPolicyMapInput
- type SinkPolicyMapOutput
- func (SinkPolicyMapOutput) ElementType() reflect.Type
- func (o SinkPolicyMapOutput) MapIndex(k pulumi.StringInput) SinkPolicyOutput
- func (o SinkPolicyMapOutput) ToSinkPolicyMapOutput() SinkPolicyMapOutput
- func (o SinkPolicyMapOutput) ToSinkPolicyMapOutputWithContext(ctx context.Context) SinkPolicyMapOutput
- type SinkPolicyOutput
- func (o SinkPolicyOutput) Arn() pulumi.StringOutput
- func (SinkPolicyOutput) ElementType() reflect.Type
- func (o SinkPolicyOutput) Policy() pulumi.StringOutput
- func (o SinkPolicyOutput) SinkId() pulumi.StringOutput
- func (o SinkPolicyOutput) SinkIdentifier() pulumi.StringOutput
- func (o SinkPolicyOutput) ToSinkPolicyOutput() SinkPolicyOutput
- func (o SinkPolicyOutput) ToSinkPolicyOutputWithContext(ctx context.Context) SinkPolicyOutput
- type SinkPolicyState
- type SinkState
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type GetLinksResult ¶ added in v5.36.0
type GetLinksResult struct {
// Set of ARN of the Links.
Arns []string `pulumi:"arns"`
// The provider-assigned unique ID for this managed resource.
Id string `pulumi:"id"`
}
A collection of values returned by getLinks.
func GetLinks ¶ added in v5.36.0
func GetLinks(ctx *pulumi.Context, opts ...pulumi.InvokeOption) (*GetLinksResult, error)
Data source for managing an AWS CloudWatch Observability Access Manager Links.
## Example Usage ### Basic Usage
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/oam" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := oam.GetLinks(ctx, nil, nil)
if err != nil {
return err
}
return nil
})
}
```
type GetSinksResult ¶ added in v5.35.0
type GetSinksResult struct {
// Set of ARN of the Sinks.
Arns []string `pulumi:"arns"`
// The provider-assigned unique ID for this managed resource.
Id string `pulumi:"id"`
}
A collection of values returned by getSinks.
func GetSinks ¶ added in v5.35.0
func GetSinks(ctx *pulumi.Context, opts ...pulumi.InvokeOption) (*GetSinksResult, error)
Data source for managing an AWS CloudWatch Observability Access Manager Sinks.
## Example Usage ### Basic Usage
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/oam" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := oam.GetSinks(ctx, nil, nil)
if err != nil {
return err
}
return nil
})
}
```
type Link ¶ added in v5.34.0
type Link struct {
pulumi.CustomResourceState
// ARN of the link.
Arn pulumi.StringOutput `pulumi:"arn"`
// Label that is assigned to this link.
Label pulumi.StringOutput `pulumi:"label"`
// Human-readable name to use to identify this source account when you are viewing data from it in the monitoring account.
LabelTemplate pulumi.StringOutput `pulumi:"labelTemplate"`
// ID string that AWS generated as part of the link ARN.
LinkId pulumi.StringOutput `pulumi:"linkId"`
// Types of data that the source account shares with the monitoring account.
ResourceTypes pulumi.StringArrayOutput `pulumi:"resourceTypes"`
// ARN of the sink that is used for this link.
SinkArn pulumi.StringOutput `pulumi:"sinkArn"`
// Identifier of the sink to use to create this link.
//
// The following arguments are optional:
SinkIdentifier pulumi.StringOutput `pulumi:"sinkIdentifier"`
// A map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
Tags pulumi.StringMapOutput `pulumi:"tags"`
TagsAll pulumi.StringMapOutput `pulumi:"tagsAll"`
}
Resource for managing an AWS CloudWatch Observability Access Manager Link.
## Example Usage ### Basic Usage
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/oam" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := oam.NewLink(ctx, "example", &oam.LinkArgs{
LabelTemplate: pulumi.String("$AccountName"),
ResourceTypes: pulumi.StringArray{
pulumi.String("AWS::CloudWatch::Metric"),
},
SinkIdentifier: pulumi.Any(aws_oam_sink.Test.Id),
Tags: pulumi.StringMap{
"Env": pulumi.String("prod"),
},
})
if err != nil {
return err
}
return nil
})
}
```
## Import
CloudWatch Observability Access Manager Link can be imported using the `arn`, e.g.,
```sh
$ pulumi import aws:oam/link:Link example arn:aws:oam:us-west-2:123456789012:link/link-id
```
func GetLink ¶ added in v5.34.0
func GetLink(ctx *pulumi.Context, name string, id pulumi.IDInput, state *LinkState, opts ...pulumi.ResourceOption) (*Link, error)
GetLink gets an existing Link resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewLink ¶ added in v5.34.0
func NewLink(ctx *pulumi.Context, name string, args *LinkArgs, opts ...pulumi.ResourceOption) (*Link, error)
NewLink registers a new resource with the given unique name, arguments, and options.
func (*Link) ElementType ¶ added in v5.34.0
func (*Link) ToLinkOutput ¶ added in v5.34.0
func (i *Link) ToLinkOutput() LinkOutput
func (*Link) ToLinkOutputWithContext ¶ added in v5.34.0
func (i *Link) ToLinkOutputWithContext(ctx context.Context) LinkOutput
type LinkArgs ¶ added in v5.34.0
type LinkArgs struct {
// Human-readable name to use to identify this source account when you are viewing data from it in the monitoring account.
LabelTemplate pulumi.StringInput
// Types of data that the source account shares with the monitoring account.
ResourceTypes pulumi.StringArrayInput
// Identifier of the sink to use to create this link.
//
// The following arguments are optional:
SinkIdentifier pulumi.StringInput
// A map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
Tags pulumi.StringMapInput
}
The set of arguments for constructing a Link resource.
func (LinkArgs) ElementType ¶ added in v5.34.0
type LinkArray ¶ added in v5.34.0
type LinkArray []LinkInput
func (LinkArray) ElementType ¶ added in v5.34.0
func (LinkArray) ToLinkArrayOutput ¶ added in v5.34.0
func (i LinkArray) ToLinkArrayOutput() LinkArrayOutput
func (LinkArray) ToLinkArrayOutputWithContext ¶ added in v5.34.0
func (i LinkArray) ToLinkArrayOutputWithContext(ctx context.Context) LinkArrayOutput
type LinkArrayInput ¶ added in v5.34.0
type LinkArrayInput interface {
pulumi.Input
ToLinkArrayOutput() LinkArrayOutput
ToLinkArrayOutputWithContext(context.Context) LinkArrayOutput
}
LinkArrayInput is an input type that accepts LinkArray and LinkArrayOutput values. You can construct a concrete instance of `LinkArrayInput` via:
LinkArray{ LinkArgs{...} }
type LinkArrayOutput ¶ added in v5.34.0
type LinkArrayOutput struct{ *pulumi.OutputState }
func (LinkArrayOutput) ElementType ¶ added in v5.34.0
func (LinkArrayOutput) ElementType() reflect.Type
func (LinkArrayOutput) Index ¶ added in v5.34.0
func (o LinkArrayOutput) Index(i pulumi.IntInput) LinkOutput
func (LinkArrayOutput) ToLinkArrayOutput ¶ added in v5.34.0
func (o LinkArrayOutput) ToLinkArrayOutput() LinkArrayOutput
func (LinkArrayOutput) ToLinkArrayOutputWithContext ¶ added in v5.34.0
func (o LinkArrayOutput) ToLinkArrayOutputWithContext(ctx context.Context) LinkArrayOutput
type LinkInput ¶ added in v5.34.0
type LinkInput interface {
pulumi.Input
ToLinkOutput() LinkOutput
ToLinkOutputWithContext(ctx context.Context) LinkOutput
}
type LinkMap ¶ added in v5.34.0
func (LinkMap) ElementType ¶ added in v5.34.0
func (LinkMap) ToLinkMapOutput ¶ added in v5.34.0
func (i LinkMap) ToLinkMapOutput() LinkMapOutput
func (LinkMap) ToLinkMapOutputWithContext ¶ added in v5.34.0
func (i LinkMap) ToLinkMapOutputWithContext(ctx context.Context) LinkMapOutput
type LinkMapInput ¶ added in v5.34.0
type LinkMapInput interface {
pulumi.Input
ToLinkMapOutput() LinkMapOutput
ToLinkMapOutputWithContext(context.Context) LinkMapOutput
}
LinkMapInput is an input type that accepts LinkMap and LinkMapOutput values. You can construct a concrete instance of `LinkMapInput` via:
LinkMap{ "key": LinkArgs{...} }
type LinkMapOutput ¶ added in v5.34.0
type LinkMapOutput struct{ *pulumi.OutputState }
func (LinkMapOutput) ElementType ¶ added in v5.34.0
func (LinkMapOutput) ElementType() reflect.Type
func (LinkMapOutput) MapIndex ¶ added in v5.34.0
func (o LinkMapOutput) MapIndex(k pulumi.StringInput) LinkOutput
func (LinkMapOutput) ToLinkMapOutput ¶ added in v5.34.0
func (o LinkMapOutput) ToLinkMapOutput() LinkMapOutput
func (LinkMapOutput) ToLinkMapOutputWithContext ¶ added in v5.34.0
func (o LinkMapOutput) ToLinkMapOutputWithContext(ctx context.Context) LinkMapOutput
type LinkOutput ¶ added in v5.34.0
type LinkOutput struct{ *pulumi.OutputState }
func (LinkOutput) Arn ¶ added in v5.34.0
func (o LinkOutput) Arn() pulumi.StringOutput
ARN of the link.
func (LinkOutput) ElementType ¶ added in v5.34.0
func (LinkOutput) ElementType() reflect.Type
func (LinkOutput) Label ¶ added in v5.34.0
func (o LinkOutput) Label() pulumi.StringOutput
Label that is assigned to this link.
func (LinkOutput) LabelTemplate ¶ added in v5.34.0
func (o LinkOutput) LabelTemplate() pulumi.StringOutput
Human-readable name to use to identify this source account when you are viewing data from it in the monitoring account.
func (LinkOutput) LinkId ¶ added in v5.34.0
func (o LinkOutput) LinkId() pulumi.StringOutput
ID string that AWS generated as part of the link ARN.
func (LinkOutput) ResourceTypes ¶ added in v5.34.0
func (o LinkOutput) ResourceTypes() pulumi.StringArrayOutput
Types of data that the source account shares with the monitoring account.
func (LinkOutput) SinkArn ¶ added in v5.34.0
func (o LinkOutput) SinkArn() pulumi.StringOutput
ARN of the sink that is used for this link.
func (LinkOutput) SinkIdentifier ¶ added in v5.34.0
func (o LinkOutput) SinkIdentifier() pulumi.StringOutput
Identifier of the sink to use to create this link.
The following arguments are optional:
func (LinkOutput) Tags ¶ added in v5.34.0
func (o LinkOutput) Tags() pulumi.StringMapOutput
A map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
func (LinkOutput) TagsAll ¶ added in v5.34.0
func (o LinkOutput) TagsAll() pulumi.StringMapOutput
func (LinkOutput) ToLinkOutput ¶ added in v5.34.0
func (o LinkOutput) ToLinkOutput() LinkOutput
func (LinkOutput) ToLinkOutputWithContext ¶ added in v5.34.0
func (o LinkOutput) ToLinkOutputWithContext(ctx context.Context) LinkOutput
type LinkState ¶ added in v5.34.0
type LinkState struct {
// ARN of the link.
Arn pulumi.StringPtrInput
// Label that is assigned to this link.
Label pulumi.StringPtrInput
// Human-readable name to use to identify this source account when you are viewing data from it in the monitoring account.
LabelTemplate pulumi.StringPtrInput
// ID string that AWS generated as part of the link ARN.
LinkId pulumi.StringPtrInput
// Types of data that the source account shares with the monitoring account.
ResourceTypes pulumi.StringArrayInput
// ARN of the sink that is used for this link.
SinkArn pulumi.StringPtrInput
// Identifier of the sink to use to create this link.
//
// The following arguments are optional:
SinkIdentifier pulumi.StringPtrInput
// A map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
Tags pulumi.StringMapInput
TagsAll pulumi.StringMapInput
}
func (LinkState) ElementType ¶ added in v5.34.0
type LookupLinkArgs ¶ added in v5.36.0
type LookupLinkArgs struct {
// ARN of the link.
LinkIdentifier string `pulumi:"linkIdentifier"`
Tags map[string]string `pulumi:"tags"`
}
A collection of arguments for invoking getLink.
type LookupLinkOutputArgs ¶ added in v5.36.0
type LookupLinkOutputArgs struct {
// ARN of the link.
LinkIdentifier pulumi.StringInput `pulumi:"linkIdentifier"`
Tags pulumi.StringMapInput `pulumi:"tags"`
}
A collection of arguments for invoking getLink.
func (LookupLinkOutputArgs) ElementType ¶ added in v5.36.0
func (LookupLinkOutputArgs) ElementType() reflect.Type
type LookupLinkResult ¶ added in v5.36.0
type LookupLinkResult struct {
// ARN of the link.
Arn string `pulumi:"arn"`
// The provider-assigned unique ID for this managed resource.
Id string `pulumi:"id"`
// Label that is assigned to this link.
Label string `pulumi:"label"`
// Human-readable name used to identify this source account when you are viewing data from it in the monitoring account.
LabelTemplate string `pulumi:"labelTemplate"`
// ID string that AWS generated as part of the link ARN.
LinkId string `pulumi:"linkId"`
LinkIdentifier string `pulumi:"linkIdentifier"`
// Types of data that the source account shares with the monitoring account.
ResourceTypes []string `pulumi:"resourceTypes"`
// ARN of the sink that is used for this link.
SinkArn string `pulumi:"sinkArn"`
Tags map[string]string `pulumi:"tags"`
}
A collection of values returned by getLink.
func LookupLink ¶ added in v5.36.0
func LookupLink(ctx *pulumi.Context, args *LookupLinkArgs, opts ...pulumi.InvokeOption) (*LookupLinkResult, error)
Data source for managing an AWS CloudWatch Observability Access Manager Link.
## Example Usage ### Basic Usage
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/oam" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := oam.LookupLink(ctx, &oam.LookupLinkArgs{
LinkIdentifier: "arn:aws:oam:us-west-1:111111111111:link/abcd1234-a123-456a-a12b-a123b456c789",
}, nil)
if err != nil {
return err
}
return nil
})
}
```
type LookupLinkResultOutput ¶ added in v5.36.0
type LookupLinkResultOutput struct{ *pulumi.OutputState }
A collection of values returned by getLink.
func LookupLinkOutput ¶ added in v5.36.0
func LookupLinkOutput(ctx *pulumi.Context, args LookupLinkOutputArgs, opts ...pulumi.InvokeOption) LookupLinkResultOutput
func (LookupLinkResultOutput) Arn ¶ added in v5.36.0
func (o LookupLinkResultOutput) Arn() pulumi.StringOutput
ARN of the link.
func (LookupLinkResultOutput) ElementType ¶ added in v5.36.0
func (LookupLinkResultOutput) ElementType() reflect.Type
func (LookupLinkResultOutput) Id ¶ added in v5.36.0
func (o LookupLinkResultOutput) Id() pulumi.StringOutput
The provider-assigned unique ID for this managed resource.
func (LookupLinkResultOutput) Label ¶ added in v5.36.0
func (o LookupLinkResultOutput) Label() pulumi.StringOutput
Label that is assigned to this link.
func (LookupLinkResultOutput) LabelTemplate ¶ added in v5.36.0
func (o LookupLinkResultOutput) LabelTemplate() pulumi.StringOutput
Human-readable name used to identify this source account when you are viewing data from it in the monitoring account.
func (LookupLinkResultOutput) LinkId ¶ added in v5.36.0
func (o LookupLinkResultOutput) LinkId() pulumi.StringOutput
ID string that AWS generated as part of the link ARN.
func (LookupLinkResultOutput) LinkIdentifier ¶ added in v5.36.0
func (o LookupLinkResultOutput) LinkIdentifier() pulumi.StringOutput
func (LookupLinkResultOutput) ResourceTypes ¶ added in v5.36.0
func (o LookupLinkResultOutput) ResourceTypes() pulumi.StringArrayOutput
Types of data that the source account shares with the monitoring account.
func (LookupLinkResultOutput) SinkArn ¶ added in v5.36.0
func (o LookupLinkResultOutput) SinkArn() pulumi.StringOutput
ARN of the sink that is used for this link.
func (LookupLinkResultOutput) Tags ¶ added in v5.36.0
func (o LookupLinkResultOutput) Tags() pulumi.StringMapOutput
func (LookupLinkResultOutput) ToLookupLinkResultOutput ¶ added in v5.36.0
func (o LookupLinkResultOutput) ToLookupLinkResultOutput() LookupLinkResultOutput
func (LookupLinkResultOutput) ToLookupLinkResultOutputWithContext ¶ added in v5.36.0
func (o LookupLinkResultOutput) ToLookupLinkResultOutputWithContext(ctx context.Context) LookupLinkResultOutput
type LookupSinkArgs ¶ added in v5.35.0
type LookupSinkArgs struct {
// ARN of the sink.
SinkIdentifier string `pulumi:"sinkIdentifier"`
// Tags assigned to the sink.
Tags map[string]string `pulumi:"tags"`
}
A collection of arguments for invoking getSink.
type LookupSinkOutputArgs ¶ added in v5.35.0
type LookupSinkOutputArgs struct {
// ARN of the sink.
SinkIdentifier pulumi.StringInput `pulumi:"sinkIdentifier"`
// Tags assigned to the sink.
Tags pulumi.StringMapInput `pulumi:"tags"`
}
A collection of arguments for invoking getSink.
func (LookupSinkOutputArgs) ElementType ¶ added in v5.35.0
func (LookupSinkOutputArgs) ElementType() reflect.Type
type LookupSinkResult ¶ added in v5.35.0
type LookupSinkResult struct {
// ARN of the sink.
Arn string `pulumi:"arn"`
// The provider-assigned unique ID for this managed resource.
Id string `pulumi:"id"`
// Name of the sink.
Name string `pulumi:"name"`
// Random ID string that AWS generated as part of the sink ARN.
SinkId string `pulumi:"sinkId"`
SinkIdentifier string `pulumi:"sinkIdentifier"`
// Tags assigned to the sink.
Tags map[string]string `pulumi:"tags"`
}
A collection of values returned by getSink.
func LookupSink ¶ added in v5.35.0
func LookupSink(ctx *pulumi.Context, args *LookupSinkArgs, opts ...pulumi.InvokeOption) (*LookupSinkResult, error)
Data source for managing an AWS CloudWatch Observability Access Manager Sink.
## Example Usage ### Basic Usage
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/oam" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := oam.LookupSink(ctx, &oam.LookupSinkArgs{
SinkIdentifier: "arn:aws:oam:us-west-1:111111111111:sink/abcd1234-a123-456a-a12b-a123b456c789",
}, nil)
if err != nil {
return err
}
return nil
})
}
```
type LookupSinkResultOutput ¶ added in v5.35.0
type LookupSinkResultOutput struct{ *pulumi.OutputState }
A collection of values returned by getSink.
func LookupSinkOutput ¶ added in v5.35.0
func LookupSinkOutput(ctx *pulumi.Context, args LookupSinkOutputArgs, opts ...pulumi.InvokeOption) LookupSinkResultOutput
func (LookupSinkResultOutput) Arn ¶ added in v5.35.0
func (o LookupSinkResultOutput) Arn() pulumi.StringOutput
ARN of the sink.
func (LookupSinkResultOutput) ElementType ¶ added in v5.35.0
func (LookupSinkResultOutput) ElementType() reflect.Type
func (LookupSinkResultOutput) Id ¶ added in v5.35.0
func (o LookupSinkResultOutput) Id() pulumi.StringOutput
The provider-assigned unique ID for this managed resource.
func (LookupSinkResultOutput) Name ¶ added in v5.35.0
func (o LookupSinkResultOutput) Name() pulumi.StringOutput
Name of the sink.
func (LookupSinkResultOutput) SinkId ¶ added in v5.35.0
func (o LookupSinkResultOutput) SinkId() pulumi.StringOutput
Random ID string that AWS generated as part of the sink ARN.
func (LookupSinkResultOutput) SinkIdentifier ¶ added in v5.35.0
func (o LookupSinkResultOutput) SinkIdentifier() pulumi.StringOutput
func (LookupSinkResultOutput) Tags ¶ added in v5.35.0
func (o LookupSinkResultOutput) Tags() pulumi.StringMapOutput
Tags assigned to the sink.
func (LookupSinkResultOutput) ToLookupSinkResultOutput ¶ added in v5.35.0
func (o LookupSinkResultOutput) ToLookupSinkResultOutput() LookupSinkResultOutput
func (LookupSinkResultOutput) ToLookupSinkResultOutputWithContext ¶ added in v5.35.0
func (o LookupSinkResultOutput) ToLookupSinkResultOutputWithContext(ctx context.Context) LookupSinkResultOutput
type Sink ¶
type Sink struct {
pulumi.CustomResourceState
// ARN of the Sink.
Arn pulumi.StringOutput `pulumi:"arn"`
// Name for the sink.
//
// The following arguments are optional:
Name pulumi.StringOutput `pulumi:"name"`
// ID string that AWS generated as part of the sink ARN.
SinkId pulumi.StringOutput `pulumi:"sinkId"`
// A map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
Tags pulumi.StringMapOutput `pulumi:"tags"`
TagsAll pulumi.StringMapOutput `pulumi:"tagsAll"`
}
Resource for managing an AWS CloudWatch Observability Access Manager Sink.
## Example Usage ### Basic Usage
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/oam" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := oam.NewSink(ctx, "example", &oam.SinkArgs{
Tags: pulumi.StringMap{
"Env": pulumi.String("prod"),
},
})
if err != nil {
return err
}
return nil
})
}
```
## Import
CloudWatch Observability Access Manager Sink can be imported using the `arn`, e.g.,
```sh
$ pulumi import aws:oam/sink:Sink example arn:aws:oam:us-west-2:123456789012:sink/sink-id
```
func GetSink ¶
func GetSink(ctx *pulumi.Context, name string, id pulumi.IDInput, state *SinkState, opts ...pulumi.ResourceOption) (*Sink, error)
GetSink gets an existing Sink resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewSink ¶
func NewSink(ctx *pulumi.Context, name string, args *SinkArgs, opts ...pulumi.ResourceOption) (*Sink, error)
NewSink registers a new resource with the given unique name, arguments, and options.
func (*Sink) ElementType ¶
func (*Sink) ToSinkOutput ¶
func (i *Sink) ToSinkOutput() SinkOutput
func (*Sink) ToSinkOutputWithContext ¶
func (i *Sink) ToSinkOutputWithContext(ctx context.Context) SinkOutput
type SinkArgs ¶
type SinkArgs struct {
// Name for the sink.
//
// The following arguments are optional:
Name pulumi.StringPtrInput
// A map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
Tags pulumi.StringMapInput
}
The set of arguments for constructing a Sink resource.
func (SinkArgs) ElementType ¶
type SinkArray ¶
type SinkArray []SinkInput
func (SinkArray) ElementType ¶
func (SinkArray) ToSinkArrayOutput ¶
func (i SinkArray) ToSinkArrayOutput() SinkArrayOutput
func (SinkArray) ToSinkArrayOutputWithContext ¶
func (i SinkArray) ToSinkArrayOutputWithContext(ctx context.Context) SinkArrayOutput
type SinkArrayInput ¶
type SinkArrayInput interface {
pulumi.Input
ToSinkArrayOutput() SinkArrayOutput
ToSinkArrayOutputWithContext(context.Context) SinkArrayOutput
}
SinkArrayInput is an input type that accepts SinkArray and SinkArrayOutput values. You can construct a concrete instance of `SinkArrayInput` via:
SinkArray{ SinkArgs{...} }
type SinkArrayOutput ¶
type SinkArrayOutput struct{ *pulumi.OutputState }
func (SinkArrayOutput) ElementType ¶
func (SinkArrayOutput) ElementType() reflect.Type
func (SinkArrayOutput) Index ¶
func (o SinkArrayOutput) Index(i pulumi.IntInput) SinkOutput
func (SinkArrayOutput) ToSinkArrayOutput ¶
func (o SinkArrayOutput) ToSinkArrayOutput() SinkArrayOutput
func (SinkArrayOutput) ToSinkArrayOutputWithContext ¶
func (o SinkArrayOutput) ToSinkArrayOutputWithContext(ctx context.Context) SinkArrayOutput
type SinkInput ¶
type SinkInput interface {
pulumi.Input
ToSinkOutput() SinkOutput
ToSinkOutputWithContext(ctx context.Context) SinkOutput
}
type SinkMap ¶
func (SinkMap) ElementType ¶
func (SinkMap) ToSinkMapOutput ¶
func (i SinkMap) ToSinkMapOutput() SinkMapOutput
func (SinkMap) ToSinkMapOutputWithContext ¶
func (i SinkMap) ToSinkMapOutputWithContext(ctx context.Context) SinkMapOutput
type SinkMapInput ¶
type SinkMapInput interface {
pulumi.Input
ToSinkMapOutput() SinkMapOutput
ToSinkMapOutputWithContext(context.Context) SinkMapOutput
}
SinkMapInput is an input type that accepts SinkMap and SinkMapOutput values. You can construct a concrete instance of `SinkMapInput` via:
SinkMap{ "key": SinkArgs{...} }
type SinkMapOutput ¶
type SinkMapOutput struct{ *pulumi.OutputState }
func (SinkMapOutput) ElementType ¶
func (SinkMapOutput) ElementType() reflect.Type
func (SinkMapOutput) MapIndex ¶
func (o SinkMapOutput) MapIndex(k pulumi.StringInput) SinkOutput
func (SinkMapOutput) ToSinkMapOutput ¶
func (o SinkMapOutput) ToSinkMapOutput() SinkMapOutput
func (SinkMapOutput) ToSinkMapOutputWithContext ¶
func (o SinkMapOutput) ToSinkMapOutputWithContext(ctx context.Context) SinkMapOutput
type SinkOutput ¶
type SinkOutput struct{ *pulumi.OutputState }
func (SinkOutput) ElementType ¶
func (SinkOutput) ElementType() reflect.Type
func (SinkOutput) Name ¶
func (o SinkOutput) Name() pulumi.StringOutput
Name for the sink.
The following arguments are optional:
func (SinkOutput) SinkId ¶
func (o SinkOutput) SinkId() pulumi.StringOutput
ID string that AWS generated as part of the sink ARN.
func (SinkOutput) Tags ¶
func (o SinkOutput) Tags() pulumi.StringMapOutput
A map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
func (SinkOutput) TagsAll ¶
func (o SinkOutput) TagsAll() pulumi.StringMapOutput
func (SinkOutput) ToSinkOutput ¶
func (o SinkOutput) ToSinkOutput() SinkOutput
func (SinkOutput) ToSinkOutputWithContext ¶
func (o SinkOutput) ToSinkOutputWithContext(ctx context.Context) SinkOutput
type SinkPolicy ¶
type SinkPolicy struct {
pulumi.CustomResourceState
// ARN of the Sink.
Arn pulumi.StringOutput `pulumi:"arn"`
// JSON policy to use. If you are updating an existing policy, the entire existing policy is replaced by what you specify here.
Policy pulumi.StringOutput `pulumi:"policy"`
// ID string that AWS generated as part of the sink ARN.
SinkId pulumi.StringOutput `pulumi:"sinkId"`
// ARN of the sink to attach this policy to.
SinkIdentifier pulumi.StringOutput `pulumi:"sinkIdentifier"`
}
Resource for managing an AWS CloudWatch Observability Access Manager Sink Policy.
## Example Usage ### Basic Usage
```go package main
import (
"encoding/json" "github.com/pulumi/pulumi-aws/sdk/v5/go/aws/oam" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
exampleSink, err := oam.NewSink(ctx, "exampleSink", nil)
if err != nil {
return err
}
tmpJSON0, err := json.Marshal(map[string]interface{}{
"Version": "2012-10-17",
"Statement": []map[string]interface{}{
map[string]interface{}{
"Action": []string{
"oam:CreateLink",
"oam:UpdateLink",
},
"Effect": "Allow",
"Resource": "*",
"Principal": map[string]interface{}{
"AWS": []string{
"1111111111111",
"222222222222",
},
},
"Condition": map[string]interface{}{
"ForAllValues:StringEquals": map[string]interface{}{
"oam:ResourceTypes": []string{
"AWS::CloudWatch::Metric",
"AWS::Logs::LogGroup",
},
},
},
},
},
})
if err != nil {
return err
}
json0 := string(tmpJSON0)
_, err = oam.NewSinkPolicy(ctx, "exampleSinkPolicy", &oam.SinkPolicyArgs{
SinkIdentifier: exampleSink.ID(),
Policy: pulumi.String(json0),
})
if err != nil {
return err
}
return nil
})
}
```
## Import
CloudWatch Observability Access Manager Sink Policy can be imported using the `sink_identifier`, e.g.,
```sh
$ pulumi import aws:oam/sinkPolicy:SinkPolicy example arn:aws:oam:us-west-2:123456789012:sink/sink-id
```
func GetSinkPolicy ¶
func GetSinkPolicy(ctx *pulumi.Context, name string, id pulumi.IDInput, state *SinkPolicyState, opts ...pulumi.ResourceOption) (*SinkPolicy, error)
GetSinkPolicy gets an existing SinkPolicy resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewSinkPolicy ¶
func NewSinkPolicy(ctx *pulumi.Context, name string, args *SinkPolicyArgs, opts ...pulumi.ResourceOption) (*SinkPolicy, error)
NewSinkPolicy registers a new resource with the given unique name, arguments, and options.
func (*SinkPolicy) ElementType ¶
func (*SinkPolicy) ElementType() reflect.Type
func (*SinkPolicy) ToSinkPolicyOutput ¶
func (i *SinkPolicy) ToSinkPolicyOutput() SinkPolicyOutput
func (*SinkPolicy) ToSinkPolicyOutputWithContext ¶
func (i *SinkPolicy) ToSinkPolicyOutputWithContext(ctx context.Context) SinkPolicyOutput
type SinkPolicyArgs ¶
type SinkPolicyArgs struct {
// JSON policy to use. If you are updating an existing policy, the entire existing policy is replaced by what you specify here.
Policy pulumi.StringInput
// ARN of the sink to attach this policy to.
SinkIdentifier pulumi.StringInput
}
The set of arguments for constructing a SinkPolicy resource.
func (SinkPolicyArgs) ElementType ¶
func (SinkPolicyArgs) ElementType() reflect.Type
type SinkPolicyArray ¶
type SinkPolicyArray []SinkPolicyInput
func (SinkPolicyArray) ElementType ¶
func (SinkPolicyArray) ElementType() reflect.Type
func (SinkPolicyArray) ToSinkPolicyArrayOutput ¶
func (i SinkPolicyArray) ToSinkPolicyArrayOutput() SinkPolicyArrayOutput
func (SinkPolicyArray) ToSinkPolicyArrayOutputWithContext ¶
func (i SinkPolicyArray) ToSinkPolicyArrayOutputWithContext(ctx context.Context) SinkPolicyArrayOutput
type SinkPolicyArrayInput ¶
type SinkPolicyArrayInput interface {
pulumi.Input
ToSinkPolicyArrayOutput() SinkPolicyArrayOutput
ToSinkPolicyArrayOutputWithContext(context.Context) SinkPolicyArrayOutput
}
SinkPolicyArrayInput is an input type that accepts SinkPolicyArray and SinkPolicyArrayOutput values. You can construct a concrete instance of `SinkPolicyArrayInput` via:
SinkPolicyArray{ SinkPolicyArgs{...} }
type SinkPolicyArrayOutput ¶
type SinkPolicyArrayOutput struct{ *pulumi.OutputState }
func (SinkPolicyArrayOutput) ElementType ¶
func (SinkPolicyArrayOutput) ElementType() reflect.Type
func (SinkPolicyArrayOutput) Index ¶
func (o SinkPolicyArrayOutput) Index(i pulumi.IntInput) SinkPolicyOutput
func (SinkPolicyArrayOutput) ToSinkPolicyArrayOutput ¶
func (o SinkPolicyArrayOutput) ToSinkPolicyArrayOutput() SinkPolicyArrayOutput
func (SinkPolicyArrayOutput) ToSinkPolicyArrayOutputWithContext ¶
func (o SinkPolicyArrayOutput) ToSinkPolicyArrayOutputWithContext(ctx context.Context) SinkPolicyArrayOutput
type SinkPolicyInput ¶
type SinkPolicyInput interface {
pulumi.Input
ToSinkPolicyOutput() SinkPolicyOutput
ToSinkPolicyOutputWithContext(ctx context.Context) SinkPolicyOutput
}
type SinkPolicyMap ¶
type SinkPolicyMap map[string]SinkPolicyInput
func (SinkPolicyMap) ElementType ¶
func (SinkPolicyMap) ElementType() reflect.Type
func (SinkPolicyMap) ToSinkPolicyMapOutput ¶
func (i SinkPolicyMap) ToSinkPolicyMapOutput() SinkPolicyMapOutput
func (SinkPolicyMap) ToSinkPolicyMapOutputWithContext ¶
func (i SinkPolicyMap) ToSinkPolicyMapOutputWithContext(ctx context.Context) SinkPolicyMapOutput
type SinkPolicyMapInput ¶
type SinkPolicyMapInput interface {
pulumi.Input
ToSinkPolicyMapOutput() SinkPolicyMapOutput
ToSinkPolicyMapOutputWithContext(context.Context) SinkPolicyMapOutput
}
SinkPolicyMapInput is an input type that accepts SinkPolicyMap and SinkPolicyMapOutput values. You can construct a concrete instance of `SinkPolicyMapInput` via:
SinkPolicyMap{ "key": SinkPolicyArgs{...} }
type SinkPolicyMapOutput ¶
type SinkPolicyMapOutput struct{ *pulumi.OutputState }
func (SinkPolicyMapOutput) ElementType ¶
func (SinkPolicyMapOutput) ElementType() reflect.Type
func (SinkPolicyMapOutput) MapIndex ¶
func (o SinkPolicyMapOutput) MapIndex(k pulumi.StringInput) SinkPolicyOutput
func (SinkPolicyMapOutput) ToSinkPolicyMapOutput ¶
func (o SinkPolicyMapOutput) ToSinkPolicyMapOutput() SinkPolicyMapOutput
func (SinkPolicyMapOutput) ToSinkPolicyMapOutputWithContext ¶
func (o SinkPolicyMapOutput) ToSinkPolicyMapOutputWithContext(ctx context.Context) SinkPolicyMapOutput
type SinkPolicyOutput ¶
type SinkPolicyOutput struct{ *pulumi.OutputState }
func (SinkPolicyOutput) ElementType ¶
func (SinkPolicyOutput) ElementType() reflect.Type
func (SinkPolicyOutput) Policy ¶
func (o SinkPolicyOutput) Policy() pulumi.StringOutput
JSON policy to use. If you are updating an existing policy, the entire existing policy is replaced by what you specify here.
func (SinkPolicyOutput) SinkId ¶
func (o SinkPolicyOutput) SinkId() pulumi.StringOutput
ID string that AWS generated as part of the sink ARN.
func (SinkPolicyOutput) SinkIdentifier ¶
func (o SinkPolicyOutput) SinkIdentifier() pulumi.StringOutput
ARN of the sink to attach this policy to.
func (SinkPolicyOutput) ToSinkPolicyOutput ¶
func (o SinkPolicyOutput) ToSinkPolicyOutput() SinkPolicyOutput
func (SinkPolicyOutput) ToSinkPolicyOutputWithContext ¶
func (o SinkPolicyOutput) ToSinkPolicyOutputWithContext(ctx context.Context) SinkPolicyOutput
type SinkPolicyState ¶
type SinkPolicyState struct {
// ARN of the Sink.
Arn pulumi.StringPtrInput
// JSON policy to use. If you are updating an existing policy, the entire existing policy is replaced by what you specify here.
Policy pulumi.StringPtrInput
// ID string that AWS generated as part of the sink ARN.
SinkId pulumi.StringPtrInput
// ARN of the sink to attach this policy to.
SinkIdentifier pulumi.StringPtrInput
}
func (SinkPolicyState) ElementType ¶
func (SinkPolicyState) ElementType() reflect.Type
type SinkState ¶
type SinkState struct {
// ARN of the Sink.
Arn pulumi.StringPtrInput
// Name for the sink.
//
// The following arguments are optional:
Name pulumi.StringPtrInput
// ID string that AWS generated as part of the sink ARN.
SinkId pulumi.StringPtrInput
// A map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
Tags pulumi.StringMapInput
TagsAll pulumi.StringMapInput
}