Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. auditmanager
  5. FrameworkShare
AWS v6.78.0 published on Thursday, Apr 24, 2025 by Pulumi
pulumi/pulumi-aws

aws.auditmanager.FrameworkShare

Explore with Pulumi AI

AWS v6.78.0 published on Thursday, Apr 24, 2025 by Pulumi
pulumi/pulumi-aws

Resource for managing an AWS Audit Manager Framework Share.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.auditmanager.FrameworkShare("example", {
    destinationAccount: "123456789012",
    destinationRegion: "us-east-1",
    frameworkId: exampleAwsAuditmanagerFramework.id,
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.auditmanager.FrameworkShare("example",
    destination_account="123456789012",
    destination_region="us-east-1",
    framework_id=example_aws_auditmanager_framework["id"])
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/auditmanager"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := auditmanager.NewFrameworkShare(ctx, "example", &auditmanager.FrameworkShareArgs{
			DestinationAccount: pulumi.String("123456789012"),
			DestinationRegion:  pulumi.String("us-east-1"),
			FrameworkId:        pulumi.Any(exampleAwsAuditmanagerFramework.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Auditmanager.FrameworkShare("example", new()
    {
        DestinationAccount = "123456789012",
        DestinationRegion = "us-east-1",
        FrameworkId = exampleAwsAuditmanagerFramework.Id,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.auditmanager.FrameworkShare;
import com.pulumi.aws.auditmanager.FrameworkShareArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new FrameworkShare("example", FrameworkShareArgs.builder()
            .destinationAccount("123456789012")
            .destinationRegion("us-east-1")
            .frameworkId(exampleAwsAuditmanagerFramework.id())
            .build());

    }
}
Copy
resources:
  example:
    type: aws:auditmanager:FrameworkShare
    properties:
      destinationAccount: '123456789012'
      destinationRegion: us-east-1
      frameworkId: ${exampleAwsAuditmanagerFramework.id}
Copy

Create FrameworkShare Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new FrameworkShare(name: string, args: FrameworkShareArgs, opts?: CustomResourceOptions);
@overload
def FrameworkShare(resource_name: str,
                   args: FrameworkShareArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def FrameworkShare(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   destination_account: Optional[str] = None,
                   destination_region: Optional[str] = None,
                   framework_id: Optional[str] = None,
                   comment: Optional[str] = None)
func NewFrameworkShare(ctx *Context, name string, args FrameworkShareArgs, opts ...ResourceOption) (*FrameworkShare, error)
public FrameworkShare(string name, FrameworkShareArgs args, CustomResourceOptions? opts = null)
public FrameworkShare(String name, FrameworkShareArgs args)
public FrameworkShare(String name, FrameworkShareArgs args, CustomResourceOptions options)

type: aws:auditmanager:FrameworkShare
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. FrameworkShareArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. FrameworkShareArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. FrameworkShareArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. FrameworkShareArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. FrameworkShareArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var frameworkShareResource = new Aws.Auditmanager.FrameworkShare("frameworkShareResource", new()
{
    DestinationAccount = "string",
    DestinationRegion = "string",
    FrameworkId = "string",
    Comment = "string",
});
Copy
example, err := auditmanager.NewFrameworkShare(ctx, "frameworkShareResource", &auditmanager.FrameworkShareArgs{
	DestinationAccount: pulumi.String("string"),
	DestinationRegion:  pulumi.String("string"),
	FrameworkId:        pulumi.String("string"),
	Comment:            pulumi.String("string"),
})
Copy
var frameworkShareResource = new FrameworkShare("frameworkShareResource", FrameworkShareArgs.builder()
    .destinationAccount("string")
    .destinationRegion("string")
    .frameworkId("string")
    .comment("string")
    .build());
Copy
framework_share_resource = aws.auditmanager.FrameworkShare("frameworkShareResource",
    destination_account="string",
    destination_region="string",
    framework_id="string",
    comment="string")
Copy
const frameworkShareResource = new aws.auditmanager.FrameworkShare("frameworkShareResource", {
    destinationAccount: "string",
    destinationRegion: "string",
    frameworkId: "string",
    comment: "string",
});
Copy
type: aws:auditmanager:FrameworkShare
properties:
    comment: string
    destinationAccount: string
    destinationRegion: string
    frameworkId: string
Copy

FrameworkShare Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The FrameworkShare resource accepts the following input properties:

DestinationAccount This property is required. string
Amazon Web Services account of the recipient.
DestinationRegion This property is required. string
Amazon Web Services region of the recipient.
FrameworkId This property is required. string

Unique identifier for the shared custom framework.

The following arguments are optional:

Comment string
Comment from the sender about the share request.
DestinationAccount This property is required. string
Amazon Web Services account of the recipient.
DestinationRegion This property is required. string
Amazon Web Services region of the recipient.
FrameworkId This property is required. string

Unique identifier for the shared custom framework.

The following arguments are optional:

Comment string
Comment from the sender about the share request.
destinationAccount This property is required. String
Amazon Web Services account of the recipient.
destinationRegion This property is required. String
Amazon Web Services region of the recipient.
frameworkId This property is required. String

Unique identifier for the shared custom framework.

The following arguments are optional:

comment String
Comment from the sender about the share request.
destinationAccount This property is required. string
Amazon Web Services account of the recipient.
destinationRegion This property is required. string
Amazon Web Services region of the recipient.
frameworkId This property is required. string

Unique identifier for the shared custom framework.

The following arguments are optional:

comment string
Comment from the sender about the share request.
destination_account This property is required. str
Amazon Web Services account of the recipient.
destination_region This property is required. str
Amazon Web Services region of the recipient.
framework_id This property is required. str

Unique identifier for the shared custom framework.

The following arguments are optional:

comment str
Comment from the sender about the share request.
destinationAccount This property is required. String
Amazon Web Services account of the recipient.
destinationRegion This property is required. String
Amazon Web Services region of the recipient.
frameworkId This property is required. String

Unique identifier for the shared custom framework.

The following arguments are optional:

comment String
Comment from the sender about the share request.

Outputs

All input properties are implicitly available as output properties. Additionally, the FrameworkShare resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Status string
Status of the share request.
Id string
The provider-assigned unique ID for this managed resource.
Status string
Status of the share request.
id String
The provider-assigned unique ID for this managed resource.
status String
Status of the share request.
id string
The provider-assigned unique ID for this managed resource.
status string
Status of the share request.
id str
The provider-assigned unique ID for this managed resource.
status str
Status of the share request.
id String
The provider-assigned unique ID for this managed resource.
status String
Status of the share request.

Look up Existing FrameworkShare Resource

Get an existing FrameworkShare resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: FrameworkShareState, opts?: CustomResourceOptions): FrameworkShare
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        comment: Optional[str] = None,
        destination_account: Optional[str] = None,
        destination_region: Optional[str] = None,
        framework_id: Optional[str] = None,
        status: Optional[str] = None) -> FrameworkShare
func GetFrameworkShare(ctx *Context, name string, id IDInput, state *FrameworkShareState, opts ...ResourceOption) (*FrameworkShare, error)
public static FrameworkShare Get(string name, Input<string> id, FrameworkShareState? state, CustomResourceOptions? opts = null)
public static FrameworkShare get(String name, Output<String> id, FrameworkShareState state, CustomResourceOptions options)
resources:  _:    type: aws:auditmanager:FrameworkShare    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Comment string
Comment from the sender about the share request.
DestinationAccount string
Amazon Web Services account of the recipient.
DestinationRegion string
Amazon Web Services region of the recipient.
FrameworkId string

Unique identifier for the shared custom framework.

The following arguments are optional:

Status string
Status of the share request.
Comment string
Comment from the sender about the share request.
DestinationAccount string
Amazon Web Services account of the recipient.
DestinationRegion string
Amazon Web Services region of the recipient.
FrameworkId string

Unique identifier for the shared custom framework.

The following arguments are optional:

Status string
Status of the share request.
comment String
Comment from the sender about the share request.
destinationAccount String
Amazon Web Services account of the recipient.
destinationRegion String
Amazon Web Services region of the recipient.
frameworkId String

Unique identifier for the shared custom framework.

The following arguments are optional:

status String
Status of the share request.
comment string
Comment from the sender about the share request.
destinationAccount string
Amazon Web Services account of the recipient.
destinationRegion string
Amazon Web Services region of the recipient.
frameworkId string

Unique identifier for the shared custom framework.

The following arguments are optional:

status string
Status of the share request.
comment str
Comment from the sender about the share request.
destination_account str
Amazon Web Services account of the recipient.
destination_region str
Amazon Web Services region of the recipient.
framework_id str

Unique identifier for the shared custom framework.

The following arguments are optional:

status str
Status of the share request.
comment String
Comment from the sender about the share request.
destinationAccount String
Amazon Web Services account of the recipient.
destinationRegion String
Amazon Web Services region of the recipient.
frameworkId String

Unique identifier for the shared custom framework.

The following arguments are optional:

status String
Status of the share request.

Import

Using pulumi import, import Audit Manager Framework Share using the id. For example:

$ pulumi import aws:auditmanager/frameworkShare:FrameworkShare example abcdef-123456
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.78.0 published on Thursday, Apr 24, 2025 by Pulumi
pulumi/pulumi-aws