Visibility Enum
Visibility type for a GraphQL API.
| Source | aws-appsync/lib/graphqlapi-base.ts |
|---|---|
| Type last changed |
Example
ts
const api = new appsync.GraphqlApi(this, 'api', {
name: 'MyPrivateAPI',
definition: appsync.Definition.fromFile(path.join(__dirname, 'appsync.schema.graphql')),
visibility: appsync.Visibility.PRIVATE,
});
python
api = appsync.GraphqlApi(self, "api",
name="MyPrivateAPI",
definition=appsync.Definition.from_file(path.join(__dirname, "appsync.schema.graphql")),
visibility=appsync.Visibility.PRIVATE
)
java
GraphqlApi api = GraphqlApi.Builder.create(this, "api")
.name("MyPrivateAPI")
.definition(Definition.fromFile(join(__dirname, "appsync.schema.graphql")))
.visibility(Visibility.PRIVATE)
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
var api = new GraphqlApi(this, "api", new GraphqlApiProps {
Name = "MyPrivateAPI",
Definition = Definition.FromFile(Join(__dirname, "appsync.schema.graphql")),
Visibility = Visibility.PRIVATE
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
api := appsync.NewGraphqlApi(this, jsii.String("api"), &GraphqlApiProps{
Name: jsii.String("MyPrivateAPI"),
Definition: appsync.Definition_FromFile(path.join(__dirname, jsii.String("appsync.schema.graphql"))),
Visibility: appsync.Visibility_PRIVATE,
})
Members
| Member | Description |
|---|---|
GLOBAL | Public, open to the internet. |
PRIVATE | Only accessible through a VPC. |
Referenced by
GraphqlApi.visibilityvisibilityvisibilityVisibilityVisibilityGraphqlApiAttributes.visibilityvisibilityvisibilityVisibilityVisibilityGraphqlApiBase.visibilityvisibilityvisibilityVisibilityVisibilityGraphqlApiProps.visibilityvisibilityvisibilityVisibilityVisibilityIGraphqlApi.visibilityvisibilityvisibilityVisibilityVisibility